queue_it 1.1.7 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a7b1505eda52ea1576812bb670baec3bcabdb7c5
-  data.tar.gz: bd7e13731fca84a9ee97d668b8af05ead0d710c1
+SHA256:
+  metadata.gz: 11e2e993d7d7786358079cd70de8f3e0c5937e5b17838dbf018885aac63b3aab
+  data.tar.gz: c96be7f3a372d1259f431fb803588a1377edee8552454572ec245c924b7d8523
 SHA512:
-  metadata.gz: f651fd91b75787ad78d6dfd3a8344b330202d83a76c8b961757b7b06526f274d0bdfed241c2ae33b94557dfff392b22bdb691fddff9957b2a0a6e93eda780f5a
-  data.tar.gz: 32e113df2386296f148beabf018b296382c169f18dc060fde80efcc0eca094002e129c19f9afbd6e10fbfe8ede8b0e41e26cac3b9d0885fbad365672c118d1c1
+  metadata.gz: '009611414e2b920b4e3fb84a9b62fbd79957f6ba3454a966218e30c299afb051ca60afff1fa1910a852176b01e3f6d9b483b43e023913f9ec8a4ea36dd45f0e5'
+  data.tar.gz: 452e61cfdfd7a168d752cf5e687347c45ddbc740b751160428e605a7ff7a21115572867331ff39ecaea240cee20f7d36862c80e5e4ab2f9aaa46c347d476aecc

data/.rbenv-gemsets

@@ -0,0 +1 @@
+queue-it

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+### 2.0.2 - 2021-07-21
+
+* Defaults changed when creating/updating a queue: CustomLayout set to dark theme, MaxNoOfRedirectsPrQueueId to 3, QueueNumberValidityInMinutes to 30.
+* UseSSL parameter is no longer sent since the use of https will be enforced.
+
+### 2.0.1 - 2021-04-26
+
+* Updated the queue and cancel URL from `q.queue-it.net` to `customer_id.queue-it.net`.
+* Updated the queue URLs to use https.
+
+### 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

data/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

data/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 @@ module QueueIt
 
       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,

data/lib/queue_it/api/event.rb

@@ -11,7 +11,7 @@ module QueueIt
         self.client = client
       end
 
-      def create_or_update(event_id:, display_name:, start_time:, pre_queue_start_time:nil, know_user_secret_key: nil, redirect_url:, end_time: nil, description: "", event_culture_name: "en-US", time_zone: "UTC", queue_number_validity_in_minutes: 15)
+      def create_or_update(event_id:, display_name:, start_time:, pre_queue_start_time:nil, know_user_secret_key: nil, redirect_url:, end_time: nil, description: "", event_culture_name: "en-US", time_zone: "UTC", queue_number_validity_in_minutes: 30, max_no_of_redirects: 1, custom_layout: "Default layout by Queue-it")
         raise InvalidEventIdFormat unless valid_event_id_format?(event_id)
 
         attributes = queue_attributes(
@@ -24,7 +24,10 @@ module QueueIt
           display_name:                     display_name,
           event_culture_name:               event_culture_name,
           queue_number_validity_in_minutes: queue_number_validity_in_minutes,
-          time_zone:                        time_zone)
+          time_zone:                        time_zone,
+          max_no_of_redirects:              max_no_of_redirects,
+          custom_layout:                    custom_layout
+          )
 
         perform_request(:put, event_id, attributes)
       end
@@ -97,7 +100,7 @@ module QueueIt
         MICROSOFT_TIME_ZONE_INDEX_VALUES.fetch(time_zone, time_zone)
       end
 
-      def queue_attributes(pre_queue_start_time:, start_time:, end_time:, know_user_secret_key:, redirect_url:, description:, display_name:, event_culture_name:, queue_number_validity_in_minutes:, time_zone:)
+      def queue_attributes(pre_queue_start_time:, start_time:, end_time:, know_user_secret_key:, redirect_url:, description:, display_name:, event_culture_name:, queue_number_validity_in_minutes:, time_zone:, max_no_of_redirects:, custom_layout:)
         {
           "DisplayName"                  => display_name,
           "RedirectUrl"                  => URI(redirect_url).to_s,
@@ -107,17 +110,16 @@ module QueueIt
           "EventStartTime"               => format_time( utc_start_time(start_time) ),
           "EventEndTime"                 => format_time( utc_end_time(start_time, end_time) ),
           "EventCulture"                 => event_culture_name,
-          "MaxNoOfRedirectsPrQueueId"    => "1",
+          "MaxNoOfRedirectsPrQueueId"    => "#{max_no_of_redirects}",
           "QueueNumberValidityInMinutes" => "#{queue_number_validity_in_minutes}",
           "AfterEventLogic"              => "RedirectUsersToTargetPage",
           "AfterEventRedirectPage"       => "",
-          "UseSSL"                       => "Auto",
           "JavaScriptSupportEnabled"     => "False",
           "TargetUrlSupportEnabled"      => "True",
           "SafetyNetMode"                => "Disabled",
           "KnowUserSecurity"             => "MD5Hash",
           "KnowUserSecretKey"            => know_user_secret_key,
-          "CustomLayout"                 => "Default layout by Queue-it",
+          "CustomLayout"                 => custom_layout,
           "XUsersInFrontOfYou"           => nil,
           "TargetUrlValidationRegex"     => "",
           "DomainAlias"                  => "",

data/lib/queue_it/url_builder.rb

@@ -3,11 +3,11 @@ require 'addressable/uri'
 module QueueIt
   class UrlBuilder
     def self.build_queue_url(customer_id, event_id, redirect_url)
-      "http://q.queue-it.net/?c=#{customer_id}&e=#{event_id}&t=#{CGI.escape(redirect_url)}"
+      "https://#{customer_id}.queue-it.net/?c=#{customer_id}&e=#{event_id}&t=#{CGI.escape(redirect_url)}"
     end
 
     def self.build_cancel_url(customer_id, event_id, queue_id = nil)
-      "http://q.queue-it.net/cancel.aspx?c=#{customer_id}&e=#{event_id}&q=#{queue_id}"
+      "https://#{customer_id}.queue-it.net/cancel.aspx?c=#{customer_id}&e=#{event_id}&q=#{queue_id}"
     end
 
     # Removes all queue_it params from URL

data/lib/queue_it/version.rb

@@ -1,3 +1,3 @@
 module QueueIt
-  VERSION = "1.1.7"
+  VERSION = "2.0.2"
 end

data/queue_it.gemspec

@@ -19,10 +19,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "addressable", "~> 2.3"
-  spec.add_runtime_dependency "faraday", "~> 0.9"
-  spec.add_runtime_dependency "faraday_middleware", "~> 0.9"
+  spec.add_runtime_dependency "faraday", "<= 2.0", ">= 0.9"
+  spec.add_runtime_dependency "faraday_middleware", "<= 2.0", ">= 0.9"
 
   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

data/spec/queue_it/api/client_spec.rb

@@ -5,7 +5,7 @@ require 'queue_it/api/client'
 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 QueueIt
       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 QueueIt
       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")

data/spec/queue_it/api/event_spec.rb

@@ -20,7 +20,7 @@ module QueueIt
         let(:pre_queue_start_time)     { Time.new(2015,04,28,15,25,46, "+02:00") }
         let(:start_time)               { Time.new(2015,04,28,17,25,46, "+02:00") }
         let(:end_time)                 { Time.new(2015,04,28,21,25,46, "+02:00") }
-        let(:queue_number_validity_in_minutes) { 15 }
+        let(:queue_number_validity_in_minutes) { 30 }
 
         specify "Submits proper request" do
           expect(client).to receive(:put).with(event_id, valid_create_body).and_return(double(body:{}))
@@ -108,12 +108,12 @@ module QueueIt
         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,
@@ -146,7 +146,6 @@ module QueueIt
             "QueueNumberValidityInMinutes" => "#{queue_number_validity_in_minutes}",
             "AfterEventLogic"              => "RedirectUsersToTargetPage",
             "AfterEventRedirectPage"       => "",
-            "UseSSL"                       => "Auto",
             "JavaScriptSupportEnabled"     => "False",
             "TargetUrlSupportEnabled"      => "True",
             "SafetyNetMode"                => "Disabled",
@@ -165,13 +164,13 @@ module QueueIt
       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 +181,7 @@ module QueueIt
         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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: queue_it
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: 2.0.2
 platform: ruby
 authors:
 - Billetto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-06 00:00:00.000000000 Z
+date: 2021-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -28,28 +28,40 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
@@ -86,14 +98,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '3.3'
 description: Gem to handle the implementation of http://queue-it.net!
 email:
 - development@billetto.dk
@@ -102,6 +114,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rbenv-gemsets"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -142,8 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Gem to handle the implementation of http://queue-it.net