Merge pull request #7 from gfish/handle-customer-id-in-the-request-url

Include customer ID in the API request URL

Author: jakubkosinski

CHANGELOG.md

@@ -1,3 +1,9 @@
+### 2.0.0 - 2020-10-29
+
+* A customer ID is needed to create a client instance
+* Always include the Customer ID in the API request URL
+* Bump webmock to properly handle Ruby 2.4+
+
 ### 1.1.6 - 2017-03-15
 
 * Now by default, during creation event, we support using redirect urls

README.md

@@ -80,7 +80,7 @@ end
 Initialize client to pass it as a dependency to `Event` instance.
 
 ``` ruby
-client = QueueIt::Api::Client.new(api_key: "SECRET_API_KEY")
+client = QueueIt::Api::Client.new("YOUR_CUSTOMER_ID", api_key: "SECRET_API_KEY")
 ```
 
 #### Event

lib/queue_it/api/client.rb

@@ -8,11 +8,12 @@ module QueueIt
   module Api
     class Client
       JSON_FORMAT  = "application/json".freeze
-      ENDPOINT_URL = URI("https://api2.queue-it.net/2_0/event").freeze
 
-      def initialize(api_key: nil, debug: false)
+      def initialize(customer_id, api_key: nil, debug: false)
+        self.customer_id = customer_id
         self.api_key = api_key
         self.debug   = debug
+        self.endpoint = URI("https://#{customer_id}.api2.queue-it.net/2_0/event")
       end
 
       def put(path, body)
@@ -21,11 +22,11 @@ def put(path, body)
 
       private
 
-      attr_accessor :api_key, :debug
+      attr_accessor :api_key, :customer_id, :debug, :endpoint
 
       def options
         {
-          url: ENDPOINT_URL.dup,
+          url: endpoint.dup,
           headers: {
             accept: JSON_FORMAT,
             content_type: JSON_FORMAT,

lib/queue_it/version.rb

@@ -1,3 +1,3 @@
 module QueueIt
-  VERSION = "1.1.8"
+  VERSION = "2.0.0"
 end

queue_it.gemspec

@@ -24,5 +24,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rspec", "~> 3.2"
-  spec.add_development_dependency "webmock", "~> 1.21"
+  spec.add_development_dependency "webmock", "~> 3.3"
 end

spec/queue_it/api/client_spec.rb

@@ -5,7 +5,7 @@
 module QueueIt
   module Api
     describe Client do
-      subject(:client) { described_class.new(api_key: "SECURE_KEY") }
+      subject(:client) { Client.new("customerid", api_key: "SECURE_KEY") }
 
       specify "PUT data under given endpoint & path in JSON format" do
         request_hash  = { "Request" => true }
@@ -71,7 +71,7 @@ module Api
       end
 
       specify "debugging mode puts to STDOUT" do
-        client = Client.new(api_key: "SECURE_KEY", debug: true)
+        client = Client.new("customerid", api_key: "SECURE_KEY", debug: true)
 
         request_hash  = { "Request"  => true }
 
@@ -83,7 +83,7 @@ module Api
       private
 
       def endpoint_url
-        Client::ENDPOINT_URL.to_s + "/fancy_event"
+        "https://customerid.api2.queue-it.net/2_0/event/fancy_event"
       end
 
       def stub_request_factory(method: :put, status: 200, request_body: "{}", response_body: "{}", content_type: "application/json")

spec/queue_it/api/event_spec.rb

@@ -108,12 +108,12 @@ module Api
         end
 
         specify "Request hits proper endpoint" do
-          client        = Client.new(api_key: "SECURE_KEY")
+          client        = Client.new("customerid", api_key: "SECURE_KEY")
           event_adapter = Event.new(client)
 
           body = JSON.generate(valid_create_body)
 
-          stub = stub_request(:put, "https://api2.queue-it.net/2_0/event/fancyevent")
+          stub = stub_request(:put, "https://customerid.api2.queue-it.net/2_0/event/fancyevent")
             .with(body: body, headers: headers)
 
           event_adapter.create_or_update(event_id:                         event_id,
@@ -165,13 +165,13 @@ module Api
       end
 
       context "#set_speed" do
-        let(:client)                   { Client.new(api_key: "SECURE_KEY") }
+        let(:client)                   { Client.new("customerid", api_key: "SECURE_KEY") }
         let(:max_redirects_per_minute) { 15 }
 
         specify "Proper speed value is set" do
           body = { "MaxRedirectsPerMinute" => "15" }
 
-          stub = stub_request(:put, "https://api2.queue-it.net/2_0/event/fancyevent/queue/speed")
+          stub = stub_request(:put, "https://customerid.api2.queue-it.net/2_0/event/fancyevent/queue/speed")
             .with(body: body, headers: headers)
 
           event_adapter.set_speed(event_id: event_id, max_redirects_per_minute: max_redirects_per_minute)
@@ -182,7 +182,7 @@ module Api
         specify "Speed must be greater than 5 so we send at least 5" do
           expected_body = { "MaxRedirectsPerMinute" => "5" }
 
-          stub = stub_request(:put, "https://api2.queue-it.net/2_0/event/fancyevent/queue/speed")
+          stub = stub_request(:put, "https://customerid.api2.queue-it.net/2_0/event/fancyevent/queue/speed")
             .with(body: expected_body, headers: headers)
 
           event_adapter.set_speed(event_id: event_id, max_redirects_per_minute: 1)