queue_it 1.1.8 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c485ac9dd1277900f3ed127d294b5d54afcb27d3d79f80cd7fe54c668079c28f
-  data.tar.gz: 407a76048056f086591bd4fcd3088acb94f94be010f50937b0a645248258d497
+  metadata.gz: 37fa1c47d1ae47fffa2b3bc9b78dad1a983356b232329d8016ea14a6d0a2ecd2
+  data.tar.gz: e2a72cd51b72e2da2ae74f388924e59e4c2664977d8d826d2b35d1a646f4a519
 SHA512:
-  metadata.gz: 26ccccd935d7770cddfc276e3944be5664362969187b1967db1b9a239bedbd7f69e0f44bb021a8d4c40a826262b7545908ff3606eca47b5347184044e433af4b
-  data.tar.gz: 54df44820c6b12d1a9469f4187f8204dee202f898cf47ef60935aee262ad09fba40cb58937d65f27d6ffe92108adb6ea8371c0d2e5ce05249ee98b852df496d6
+  metadata.gz: e4f59ab64f17ce5991d321bfbd59ec9d4189a00cc820e080945e58877a8e58eeb368a533a464fe3f4a05e002d889f5ee0723905caf2760cfbd421502cdd938f3
+  data.tar.gz: 48a90881475da361a4b1446162f612419a6c56e250ebe1750c92b504b77a0c8d97f70d5d1909dc24f7bae490a1c076ed13639a3e0c8f688d75a31dbc16035275

data/.rbenv-gemsets

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

data/.ruby-version

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

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+### 3.0.0 - 2021-07-30
+
+* Replace session store with cookie store to prevent some users of being kicked out of the queue
+
+### 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/queueable.rb

@@ -15,18 +15,18 @@ module QueueIt
       end
 
       def queue_it_queue_id(event_id)
-        session[queue_it_session_variable(event_id)].to_i
+        cookies.signed[queue_it_session_variable(event_id)].to_i
       end
 
       def destroy_all_queue_it_sessions
         session_variable_prefix = queue_it_session_variable("")
-        session.keys.select{ |session_key| session_key.start_with?(session_variable_prefix) }.each do |key|
-          session.delete(key)
+        cookies.each do |key, _|
+          cookies.signed.delete(key) if key.starts_with?(session_variable_prefix)
         end
       end
 
       def destroy_queue_it_session(event_id)
-        session.delete(queue_it_session_variable(event_id))
+        cookies.signed.delete(queue_it_session_variable(event_id))
       end
 
       def queue_it_session_variable(event_id)
@@ -37,14 +37,14 @@ module QueueIt
 
       def create_or_verify_queue_it_session(secret_key, event_id, customer_id, request_url, params, current_tickets_url)
         # If there exists a session, we return. This needs to be refactored when we start to look at the timestamp parameter
-        return if session[queue_it_session_variable(event_id)].present?
+        return if cookies.signed[queue_it_session_variable(event_id)].present?
 
         begin
           queue_number = QueueIt::ExtractQueueNumber.new.(
             secret_key: secret_key,
             request_url: request_url,
             request_params: params)
-          session[queue_it_session_variable(event_id)] = queue_number
+          cookies.signed[queue_it_session_variable(event_id)] = { value: queue_number, expires: 24.hours.from_now }
 
           # If the request URL contains queue_it params we remove them and redirect
           # this is done to mask the params we use to create and verify the queue_it session

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.8"
+  VERSION = "3.0.0"
 end

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

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.8
+  version: 3.0.0
 platform: ruby
 authors:
 - Billetto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-23 00:00:00.000000000 Z
+date: 2021-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -28,42 +28,42 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.9'
     - - "<="
       - !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: '0.9'
     - - "<="
       - !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: '0.9'
     - - "<="
       - !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: '0.9'
     - - "<="
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -98,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
@@ -114,6 +114,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rbenv-gemsets"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -154,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Gem to handle the implementation of http://queue-it.net