tickr_client 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm use 1.9.3-p385@tickr-ruby-client --create
+

data/Gemfile

@@ -0,0 +1,11 @@
+source 'http://rubygems.org'
+
+gem 'thread_safe', '~> 0.1'
+gem 'json', '~> 1.8'
+
+group :development do
+  gem 'bundler', '~> 1.2'
+  gem 'fakeweb', '~> 1.3'
+  gem 'jeweler', '~> 1.8'
+  gem 'rspec', '~> 2.13'
+end

data/Gemfile.lock

@@ -0,0 +1,37 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    atomic (1.1.10)
+    diff-lcs (1.2.4)
+    fakeweb (1.3.0)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.8.0)
+    rake (10.1.0)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    thread_safe (0.1.0)
+      atomic
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.2)
+  fakeweb (~> 1.3)
+  jeweler (~> 1.8)
+  json (~> 1.8)
+  rspec (~> 2.13)
+  thread_safe (~> 0.1)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Wistia
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# tickr_client
+
+tickr_client is a Ruby library for talking to a [tickr ticketing server](http://github.com/wistia/tickr-server).
+
+## Getting Started
+
+It is recommended that you create a global instance of tickr_client and call it directly. TickrClients are threadsafe and the `#get_ticket` method may be called safely on a single instance from all of your request handlers and workers.
+
+Note that the threadsafe guarantee for a ticket is only its uniqueness; tickr makes no guarantee about sequentiality.
+
+    $my_tickr = TickrClient.new(
+      servers: [
+        {host: '192.168.1.1', port: 8080},
+        {host: '192.168.1.2', port: 8080},
+        {host: '192.168.1.3', port: 8080}
+      ],
+      timeout: 1000, # Try next host after 1 second.
+      cache_size: 100, # Keep up to 100 tickets (unique IDs) at the ready.
+      replenish_cache_at: 10, # Load 90 more tickets when we get down to 10.
+    )
+    
+    new_id = $my_tickr.get_ticket
+
+
+
+## Contributing to tickr_client
+ 
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise
+necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = 'tickr_client'
+  gem.homepage = 'http://github.com/wistia/tickr-ruby-client'
+  gem.license = 'MIT'
+  gem.summary = 'A Ruby Client for interacting with a Tickr server'
+  gem.description = 'A Ruby Client for interacting with a Tickr server'
+  gem.email = 'robby@freerobby.com'
+  gem.authors = ['Robby Grossman']
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tickr_client #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/tickr_client.rb

@@ -0,0 +1,82 @@
+require 'json'
+require 'net/http'
+require 'thread_safe'
+require 'timeout'
+
+class TickrClient
+  attr_accessor :servers, :timeout, :cache_size, :replenish_cache_at
+
+  def initialize(opts)
+    self.servers = opts[:servers]
+    self.timeout = opts[:timeout] || 1000
+    self.cache_size = opts[:cache_size] || 100
+    self.replenish_cache_at = opts[:replenish_cache_at] || 10
+
+    self.query_in_progress = false
+    self.next_server_index = Random.new.rand(servers.count)
+    self.tickets = ThreadSafe::Array.new
+
+    fetch_tickets
+  end
+
+  def get_ticket
+    fetch_tickets if tickets.count == 0
+    this_ticket = tickets.shift
+    fetch_tickets_async if tickets.count <= replenish_cache_at
+
+    this_ticket
+  end
+
+  protected
+  attr_accessor :next_server_index, :tickets, :query_in_progress
+
+  def fetch_tickets
+    # Try every server up to three times.
+    while !fetch_tickets_from_server(next_server_index) do
+      self.next_server_index = (self.next_server_index + 1) % servers.count
+    end
+  end
+
+  def fetch_tickets_from_server(index)
+    new_ticket_group = begin
+      uri = URI("http://#{servers[index][:host]}:#{servers[index][:port]}/tickets/create/#{replenish_capacity}")
+      Timeout::timeout(timeout / 1000.0) do
+        JSON.parse(Net::HTTP.get(uri))
+      end
+    rescue Timeout::Error
+      return false
+    end
+
+    new_tickets = create_tickets_from_ticket_group(new_ticket_group)
+    tickets.concat(new_tickets)
+    true
+  end
+
+  def fetch_tickets_async
+    return if self.query_in_progress
+    self.query_in_progress = true
+    Thread.new do
+      fetch_tickets
+      self.query_in_progress = false
+    end
+  end
+
+  def replenish_capacity
+    cache_size - tickets.count
+  end
+
+  # Create an array of tickets based on a 'ticket group' array of size 3:
+  # 1. First element of ticket group is the first ticket.
+  # 2. Second element of ticket group is the increment between consecutive tickets.
+  # 3. Third element of ticket group is the number of tickets to create.
+  def create_tickets_from_ticket_group(group)
+    initial_ticket, diff, num_of_tickets = group
+    new_tickets = [initial_ticket]
+
+    (num_of_tickets - 1).times do
+      new_tickets << new_tickets.last + diff
+    end
+
+    new_tickets
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'fakeweb'
+require 'rspec'
+require 'tickr_client'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.before(:all) do
+    FakeWeb.allow_net_connect = false
+  end
+
+  config.before(:each) do
+    FakeWeb.clean_registry
+  end
+end

data/spec/tickr_client_spec.rb

@@ -0,0 +1,160 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'tickr_client')
+
+require 'json'
+
+describe TickrClient do
+  after do
+    # Make sure threads finish before we fail based on expectations
+    Thread.list.each {|t| t.join unless t == Thread.current}
+  end
+  def get_client(opts = {})
+    TickrClient.new(
+      {servers: [{host: '127.0.0.1', port: 8080}, {host: '127.0.0.1', port: 8081}]}.merge(opts)
+    )
+  end
+  describe '#initialize' do
+    it 'sets configurable instance variables' do
+      TickrClient.any_instance.stub :fetch_tickets
+      client = TickrClient.new(
+        servers: [{host: '127.0.0.1', port: 8080}, {host: '127.0.0.1', port: 8081}],
+        timeout: 150,
+        cache_size: 500,
+        replenish_cache_at: 100
+      )
+
+      client.servers.count.should == 2
+      client.timeout.should == 150
+      client.cache_size.should == 500
+      client.replenish_cache_at.should == 100
+    end
+    it 'applies sensible defaults' do
+      TickrClient.any_instance.stub :fetch_tickets
+      client = TickrClient.new(
+        servers: [{host: '127.0.0.1', port: 8080}, {host: '127.0.0.1', port: 8081}]
+      )
+      client.timeout.should_not be_nil
+      client.cache_size.should_not be_nil
+      client.replenish_cache_at.should_not be_nil
+    end
+    it 'fetches tickets synchronously' do
+      TickrClient.any_instance.should_receive(:fetch_tickets).at_least(1)
+      TickrClient.new(
+        servers: [{host: '127.0.0.1', port: 8080}, {host: '127.0.0.1', port: 8081}]
+      )
+    end
+  end
+
+  describe '#get_ticket' do
+    it 'loads ticket from cache and removes it from the cache' do
+      TickrClient.any_instance.stub :fetch_tickets
+      client = get_client
+
+      client.send(:tickets=, [1, 2, 3, 4])
+      client.get_ticket.should == 1
+      client.send(:tickets).should == [2, 3, 4]
+    end
+
+    it 'asynchronously fetches more tickets after falling below the replenesh_cache_at threshold' do
+      TickrClient.any_instance.stub :fetch_tickets
+
+      client = get_client(cache_size: 10, replenesh_cache_at: 2)
+      client.send(:tickets=, [5, 6, 7])
+      client.should_receive :fetch_tickets_async
+      client.get_ticket
+    end
+  end
+
+  describe 'private instance methods' do
+    describe '#fetch_tickets' do
+      it 'fetches tickets from servers one at a time' do
+        Net::HTTP.should_receive(:get).and_return([1, 2, 3, 4, 5].to_json)
+        client = TickrClient.new(
+          servers: [
+            {host: '127.0.0.1', port: 8080},
+            {host: '127.0.0.1', port: 8081},
+            {host: '127.0.0.1', port: 8082},
+            {host: '127.0.0.1', port: 8083}
+          ]
+        )
+        Thread.list.each {|t| t.join unless t == Thread.current}
+
+        client.send(:next_server_index=, 0)
+        client.should_receive(:fetch_tickets_from_server).with(0).and_return(false)
+        client.should_receive(:fetch_tickets_from_server).with(1).and_return(false)
+        client.should_receive(:fetch_tickets_from_server).with(2).and_return(false)
+        client.should_receive(:fetch_tickets_from_server).with(3).and_return(true)
+        client.send(:fetch_tickets)
+      end
+    end
+
+    describe '#fetch_tickets_async' do
+      it 'fetches tickets in a separate thread' do
+        FakeWeb.register_uri :get, 'http://127.0.0.1:8080/tickets/create/10', body: [1, 1, 2].to_json
+        client = TickrClient.new(
+          servers: [
+            {host: '127.0.0.1', port: 8080}
+          ],
+          cache_size: 10
+        )
+        client.send(:tickets=, [1, 2])
+        FakeWeb.register_uri :get, 'http://127.0.0.1:8080/tickets/create/8', body: [5, 1, 8].to_json
+
+        client.send(:fetch_tickets_async)
+        client.send(:tickets).should == [1, 2] # Thread will not have finished yet
+        Thread.list.each {|t| t.join unless t == Thread.current}
+        client.send(:tickets).should == [1, 2, 5, 6, 7, 8, 9, 10, 11, 12]
+      end
+    end
+
+    describe '#fetch_tickets_from_server' do
+      it 'returns false on timeout error' do
+        TickrClient.any_instance.stub :fetch_tickets
+        client = get_client
+
+        Net::HTTP.should_receive(:get).and_raise(Timeout::Error)
+        client.send(:fetch_tickets_from_server, 0).should be_false
+      end
+
+      it 'adds tickets to array and returns true' do
+        TickrClient.any_instance.stub :fetch_tickets
+        client = TickrClient.new(
+          servers: [
+            {host: '127.0.0.1', port: 8080},
+            {host: '127.0.0.1', port: 8081},
+            {host: '127.0.0.1', port: 8082}
+          ],
+          cache_size: 10
+        )
+        client.send(:tickets=, [1, 2])
+        client.send(:next_server_index=, 1)
+
+        FakeWeb.register_uri :get, 'http://127.0.0.1:8081/tickets/create/8', body: [5, 1, 8].to_json
+
+        client.send(:fetch_tickets_from_server, 1).should be_true
+        client.send(:tickets).should == [1, 2, 5, 6, 7, 8, 9, 10, 11, 12]
+      end
+    end
+
+    describe '#replenish_capacity' do
+      it 'is the difference between the cache size and the number of tickets' do
+        TickrClient.any_instance.stub :fetch_tickets
+
+        client = get_client(cache_size: 10)
+        client.send(:tickets=, [5, 6, 7])
+        client.send(:replenish_capacity).should == 7
+      end
+    end
+
+    describe '#create_tickets_from_ticket_group' do
+      it 'should create an array of tickets' do
+        TickrClient.any_instance.stub :fetch_tickets
+
+        client = get_client
+        tickets = client.send(:create_tickets_from_ticket_group, [100, 100, 5])
+        tickets.should == [100, 200, 300, 400, 500]
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: tickr_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Robby Grossman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thread_safe
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+description: A Ruby Client for interacting with a Tickr server
+email: robby@freerobby.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/tickr_client.rb
+- spec/spec_helper.rb
+- spec/tickr_client_spec.rb
+homepage: http://github.com/wistia/tickr-ruby-client
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4284658083442582303
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A Ruby Client for interacting with a Tickr server
+test_files: []