tickr_client 0.0.1 → 1.0.0

data/Gemfile

@@ -4,8 +4,10 @@ gem 'thread_safe', '~> 0.1'
 gem 'json', '~> 1.8'
 
 group :development do
+  gem 'activerecord', '>= 2.3.0'
   gem 'bundler', '~> 1.2'
   gem 'fakeweb', '~> 1.3'
   gem 'jeweler', '~> 1.8'
   gem 'rspec', '~> 2.13'
+  gem 'sqlite3', '~> 1.3'
 end

data/Gemfile.lock

@@ -1,16 +1,36 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    activemodel (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+    activerecord (4.0.0)
+      activemodel (= 4.0.0)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.0)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.0)
     atomic (1.1.10)
+    builder (3.1.4)
     diff-lcs (1.2.4)
     fakeweb (1.3.0)
     git (1.2.5)
+    i18n (0.6.4)
     jeweler (1.8.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
       rdoc
     json (1.8.0)
+    minitest (4.7.5)
+    multi_json (1.7.7)
     rake (10.1.0)
     rdoc (4.0.1)
       json (~> 1.4)
@@ -22,16 +42,20 @@ GEM
     rspec-expectations (2.13.0)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.13.1)
+    sqlite3 (1.3.7)
     thread_safe (0.1.0)
       atomic
+    tzinfo (0.3.37)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord (>= 2.3.0)
   bundler (~> 1.2)
   fakeweb (~> 1.3)
   jeweler (~> 1.8)
   json (~> 1.8)
   rspec (~> 2.13)
+  sqlite3 (~> 1.3)
   thread_safe (~> 0.1)

data/README.md

@@ -4,11 +4,15 @@ tickr_client is a Ruby library for talking to a [tickr ticketing server](http://
 
 ## 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.
+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.
+Note that the threadsafe guarantee for a ticket is only its uniqueness; tickr
+makes no guarantee about sequentiality.
 
-    $my_tickr = TickrClient.new(
+    $tickr = TickrClient.new(
       servers: [
         {host: '192.168.1.1', port: 8080},
         {host: '192.168.1.2', port: 8080},
@@ -19,9 +23,37 @@ Note that the threadsafe guarantee for a ticket is only its uniqueness; tickr ma
       replenish_cache_at: 10, # Load 90 more tickets when we get down to 10.
     )
     
-    new_id = $my_tickr.get_ticket
+    new_id = $tickr.get_ticket
 
+## Using with ActiveRecord
 
+To use tickr with ActiveRecord, set up an initializer as outlined above. The
+ActiveRecord interface requires your tickr instance to be a global variable
+named `$tickr`. This is not presently configurable (though we'd love for you
+to make it so!).
+
+All you need to do to add ActiveRecord support to your ActiveRecord models is
+require our interface library and include our mixin, e.g.:
+
+    require 'tickr/interfaces/active_record' # not required with gem by default
+    
+    class Person < ActiveRecord::Base
+      include Tickr::Interfaces::ActiveRecord
+      
+      # …your code here
+    end
+
+Voila! Whenever you save a new object, its ID will be set via tickr and passed
+to your DBMS during its insert operation. If for any reason the ID is not set
+upon row insertion, Tickr will raise a `TickrIdNotSetError` exception so that
+no data is saved that might compromise referential integrity. If you wish to
+fall back to an auto_increment or some other DBMS-backed scheme, you should
+catch this exception.
+
+Note that MySQL happily accepts a specific ID without requiring removal of the
+AUTO_INCREMENT property on a primary key. If you use a different DBMS, please be
+sure its behavior is similarly compatible or update your database table schemas
+accordingly.
 
 ## Contributing to tickr_client
  

data/VERSION

@@ -1 +1 @@
-0.0.1
+1.0.0

data/lib/tickr/interfaces/active_record.rb

@@ -0,0 +1,22 @@
+require 'active_record'
+
+class TickrIdNotSetError < StandardError; end
+
+module Tickr
+  module Interfaces
+    module ActiveRecord
+      def self.included(base)
+        base.before_create :set_tickr_id
+        base.before_create :ensure_id_set
+
+        private
+        def set_tickr_id
+          self.id ||= $tickr.get_ticket
+        end
+        def ensure_id_set
+          raise TickrIdNotSetError if self.id.nil?
+        end
+      end
+    end
+  end
+end

data/lib/tickr_client.rb

@@ -70,7 +70,7 @@ class TickrClient
   # 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
+    initial_ticket, diff, num_of_tickets = group['first'], group['increment'], group['count']
     new_tickets = [initial_ticket]
 
     (num_of_tickets - 1).times do

data/spec/lib/tickr/interfaces/active_record_spec.rb

@@ -0,0 +1,43 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+
+require File.join(File.dirname(__FILE__), '..', '..', '..', '..', 'lib', 'tickr', 'interfaces', 'active_record')
+
+require 'active_record'
+
+describe Tickr::Interfaces::ActiveRecord do
+  before do
+    TickrClient.any_instance.stub :fetch_tickets
+    $tickr = TickrClient.new({servers: [{}]})
+
+    ActiveRecord::Base.establish_connection adapter: :sqlite3, database: ':memory:'
+    with_silenced_output do
+      ActiveRecord::Schema.define do
+        create_table 'test_models' do |t|
+          t.datetime 'created_at'
+          t.datetime 'updated_at'
+        end
+      end
+    end
+
+    class TestModel < ActiveRecord::Base
+      include Tickr::Interfaces::ActiveRecord
+    end
+  end
+
+  it 'parent accepts ID in place of an autoincrement value' do
+    # Hard-set some nonincremental IDs.
+    (TestModel.create! id: 1).id.should == 1
+    (TestModel.create! id: 6).id.should == 6
+  end
+  it 'parent creates ID from tickr' do
+    $tickr.stub(:get_ticket).and_return(115010)
+    TestModel.create!.id.should == 115010
+  end
+
+  it 'raises an exception if we save a record with no ID' do
+    obj = TestModel.new
+    obj.id.should be_nil
+    $tickr.stub(:get_ticket).and_return(nil)
+    lambda{obj.save!}.should raise_error(TickrIdNotSetError)
+  end
+end

data/spec/spec_helper.rb

@@ -11,10 +11,21 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
 RSpec.configure do |config|
   config.before(:all) do
-    FakeWeb.allow_net_connect = false
+    # Allow real HTTP connections only to our local tickr server
+    FakeWeb.allow_net_connect = %r[^https?://localhost]
   end
 
   config.before(:each) do
     FakeWeb.clean_registry
   end
 end
+
+def with_silenced_output
+  orig_stderr = $stderr
+  orig_stdout = $stdout
+  $stderr = File.new('/dev/null', 'w')
+  $stdout = File.new('/dev/null', 'w')
+  yield
+  $stderr = orig_stderr
+  $stdout = orig_stdout
+end

data/spec/tickr_client_spec.rb

@@ -69,7 +69,7 @@ describe TickrClient do
   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)
+        Net::HTTP.should_receive(:get).and_return({'first' => 1, 'increment' => 1, 'count' => 5}.to_json)
         client = TickrClient.new(
           servers: [
             {host: '127.0.0.1', port: 8080},
@@ -91,7 +91,7 @@ describe TickrClient do
 
     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
+        FakeWeb.register_uri :get, 'http://127.0.0.1:8080/tickets/create/10', body: {'first' => 1, 'increment' => 1, 'count' => 2}.to_json
         client = TickrClient.new(
           servers: [
             {host: '127.0.0.1', port: 8080}
@@ -99,7 +99,7 @@ describe TickrClient do
           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
+        FakeWeb.register_uri :get, 'http://127.0.0.1:8080/tickets/create/8', body: {'first' => 5, 'increment' => 1, 'count' => 8}.to_json
 
         client.send(:fetch_tickets_async)
         client.send(:tickets).should == [1, 2] # Thread will not have finished yet
@@ -130,7 +130,7 @@ describe TickrClient do
         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
+        FakeWeb.register_uri :get, 'http://127.0.0.1:8081/tickets/create/8', body: {'first' => 5, 'increment' => 1, 'count' => 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]
@@ -152,7 +152,7 @@ describe TickrClient do
         TickrClient.any_instance.stub :fetch_tickets
 
         client = get_client
-        tickets = client.send(:create_tickets_from_ticket_group, [100, 100, 5])
+        tickets = client.send(:create_tickets_from_ticket_group, {'first' => 100, 'increment' => 100, 'count' => 5})
         tickets.should == [100, 200, 300, 400, 500]
       end
     end

data/tickr_client.gemspec

@@ -0,0 +1,75 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "tickr_client"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Robby Grossman"]
+  s.date = "2013-07-30"
+  s.description = "A Ruby Client for interacting with a Tickr server"
+  s.email = "robby@freerobby.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".rvmrc",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/tickr/interfaces/active_record.rb",
+    "lib/tickr_client.rb",
+    "spec/lib/tickr/interfaces/active_record_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/tickr_client_spec.rb",
+    "tickr_client.gemspec"
+  ]
+  s.homepage = "http://github.com/wistia/tickr-ruby-client"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.25"
+  s.summary = "A Ruby Client for interacting with a Tickr server"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<thread_safe>, ["~> 0.1"])
+      s.add_runtime_dependency(%q<json>, ["~> 1.8"])
+      s.add_development_dependency(%q<activerecord>, [">= 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.2"])
+      s.add_development_dependency(%q<fakeweb>, ["~> 1.3"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.13"])
+      s.add_development_dependency(%q<sqlite3>, ["~> 1.3"])
+    else
+      s.add_dependency(%q<thread_safe>, ["~> 0.1"])
+      s.add_dependency(%q<json>, ["~> 1.8"])
+      s.add_dependency(%q<activerecord>, [">= 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.2"])
+      s.add_dependency(%q<fakeweb>, ["~> 1.3"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8"])
+      s.add_dependency(%q<rspec>, ["~> 2.13"])
+      s.add_dependency(%q<sqlite3>, ["~> 1.3"])
+    end
+  else
+    s.add_dependency(%q<thread_safe>, ["~> 0.1"])
+    s.add_dependency(%q<json>, ["~> 1.8"])
+    s.add_dependency(%q<activerecord>, [">= 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.2"])
+    s.add_dependency(%q<fakeweb>, ["~> 1.3"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8"])
+    s.add_dependency(%q<rspec>, ["~> 2.13"])
+    s.add_dependency(%q<sqlite3>, ["~> 1.3"])
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tickr_client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-18 00:00:00.000000000 Z
+date: 2013-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thread_safe
@@ -43,6 +43,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +123,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
 description: A Ruby Client for interacting with a Tickr server
 email: robby@freerobby.com
 executables: []
@@ -124,9 +156,12 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- lib/tickr/interfaces/active_record.rb
 - lib/tickr_client.rb
+- spec/lib/tickr/interfaces/active_record_spec.rb
 - spec/spec_helper.rb
 - spec/tickr_client_spec.rb
+- tickr_client.gemspec
 homepage: http://github.com/wistia/tickr-ruby-client
 licenses:
 - MIT
@@ -142,7 +177,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4284658083442582303
+      hash: 453379598713018140
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: