queue_it 0.0.1 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80302e4595250a93745ae5cdde295cc1ef9c4dfe
+  data.tar.gz: 98f55674bca1f8d64ea1ea35b3cc0f9f14096cd5
+SHA512:
+  metadata.gz: 734e01bc853574e3e963c60212debdc7ce9ea33e87cdb2d6b9619d7aecef8de31994a8aa7c2559935478ee0bae6a8825ecdcce1b3cc0ea90169ede943c798535
+  data.tar.gz: f86d410b4b320462e8aaa82c702ac1c1ef6eb700ec00117f212e9b2a132ef51d825cc734d52445544e7ccb4e9b21eb6c6766c806d2ba1e22e8696d4bb4c1755e

data/README.md

@@ -1,24 +1,78 @@
 # QueueIt
 
-TODO: Write a gem description
+This is a gem for integrating Ruby on Rails with Queue-it that is an online queuing system, https://queue-it.com/
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'queue_it'
+```ruby
+gem 'queue_it'
+```
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install queue_it
+```
+$ gem install queue_it
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+We are using Queue-it on http://billetto.co.ok, and we create our queued events like this:
+
+```ruby
+event  = create(:event,
+                :queue_it_enabled               => true,
+                :queue_it_customer_id           => 'billettodk',
+                :queue_it_event_id              => 'rainmaking',
+                :queue_it_known_user_secret_key => 'asdfbmnwqeklrj'
+               )
+```
+
+In our Event-model, we determine whether or not its queue-enabled:
+
+```ruby
+class Event < ActiveRecord::Base
+  def queue_enabled?
+    queue_it_enabled? &&
+    queue_it_customer_id.present? &&
+    queue_it_event_id.present? &&
+    queue_it_known_user_secret_key.present?
+  end
+end
+```
+
+For us, our precious actions are all about tickets, so we protect these actions like this:
+
+```ruby
+class EventsController < ApplicationController
+  include QueueIt::Queueable
+
+  def tickets
+    event = Event.find(params[:id])
+
+    if event.queue_enabled?
+      protect_with_queue!(event.queue_it_known_user_secret_key,
+                          event.queue_it_event_id,
+                          event.queue_it_customer_id)
+      # We use performed to see if our queue protection have rendered something,
+      # if it has rendered stop all other execution
+      return if performed?
+    end
+  end
+
+  def receipt
+    # The user has bought his/her tickets, push them out of the queue
+    destroy_all_queue_it_sessions
+  end
+end
+```
 
 ## Contributing
 

data/lib/queue_it/queueable.rb

@@ -3,6 +3,14 @@ module QueueIt
     extend ActiveSupport::Concern
 
     included do
+      def protect_with_queue!(known_user_secret_key, event_id, customer_id)
+        create_or_verify_queue_it_session(known_user_secret_key,
+                                          event_id,
+                                          customer_id,
+                                          request.url,
+                                          params)
+      end
+
       def queue_it_queue_id(event_id)
         session[queue_it_session_variable(event_id)].to_i
       end
@@ -16,6 +24,12 @@ module QueueIt
         session.delete(queue_it_session_variable(event_id))
       end
 
+      def queue_it_session_variable(event_id)
+        "KnownQueueItUser-#{event_id}"
+      end
+
+    private
+
       def create_or_verify_queue_it_session(secret_key, event_id, customer_id, request_url, params)
         # 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?
@@ -31,16 +45,13 @@ module QueueIt
           end
         rescue QueueIt::MissingArgsGiven
           queue_url = QueueIt::UrlBuilder.build_queue_url(customer_id, event_id)
+          destroy_all_queue_it_sessions
           render("queue_it/enter_queue", layout: false, locals: { queue_it_url: queue_url }) and return
         rescue QueueIt::NotAuthorized
           queue_cancel_url = QueueIt::UrlBuilder.build_cancel_url(customer_id, event_id)
+          destroy_all_queue_it_sessions
           render("queue_it/cheating_queue", layout: false, locals: { queue_it_url: queue_cancel_url }) and return
         end
-
-      end
-
-      def queue_it_session_variable(event_id)
-        "KnownQueueItUser-#{event_id}"
       end
 
     end

data/lib/queue_it/version.rb

@@ -1,3 +1,3 @@
 module QueueIt
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

data/queue_it.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency 'addressable'
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
 end

metadata

@@ -1,20 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: queue_it
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Kasper Grubbe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-06 00:00:00.000000000 Z
+date: 2014-11-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,17 +41,15 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Gem to handle the implementation of http://queue-it.net!
@@ -67,26 +76,25 @@ files:
 homepage: https://github.com/gfish/queue_it
 licenses:
 - GNU/GPLv3
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Gem to handle the implementation of http://queue-it.net
 test_files: []