oldbill 0.0.1

data/spec/session/cache_spec.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+require File.expand_path("../../spec_helper", __FILE__)
+require File.expand_path('../../vcr_enabled', __FILE__)
+
+describe "Session caching on" do
+  use_vcr_cassette 'share', :record => :new_episodes
+  
+  before(:each) do
+    @session = OldBill::Session.create(:username => ENV["OLD_BILL_USERNAME"], :password => ENV["OLD_BILL_PASSWORD"])
+  end
+  
+  describe "Cache" do
+    before(:each) do
+      @service = @session.service
+    end
+    
+    it "should create the cache key from the request" do
+      @session.forces
+      @session.cache.should_not be_empty
+      @session.cache.keys.should include("/forces/")  
+    end
+    
+    it "should give exactly the same response as the first request" do
+      response1 = @session.forces
+      response2 = @session.cache["/forces/"]
+      response1.should == response2
+      response2.should == @session.forces
+    end
+  end
+end
+
+
+describe "Session caching off" do
+  use_vcr_cassette 'share', :record => :new_episodes
+  before(:each) do
+    @session = OldBill::Session.create(:username => ENV["OLD_BILL_USERNAME"], :password => ENV["OLD_BILL_PASSWORD"], :caching => false)
+  end
+  
+  describe "Cache" do
+    before(:each) do
+      @service = @session.service
+    end
+    
+    it "should not create the cache key from the request" do
+      @session.forces
+      @session.cache.should be_nil
+    end
+  
+  end
+end
+
+describe "Session expiration" do
+  use_vcr_cassette 'share', :record => :new_episodes
+  
+  before(:each) do
+    @session = OldBill::Session.create(:username => ENV["OLD_BILL_USERNAME"], :password => ENV["OLD_BILL_PASSWORD"], :expires_in => 1)
+  end
+  
+  describe "Cache" do
+    before(:each) do
+      @service = @session.service
+    end
+    
+    it "should create the cache" do
+      @session.forces
+      @session.cache.should_not be_empty
+    end
+    
+    it "should expire when the time as gone passed expiration" do
+      @session.forces
+      @time_now = Time.parse("Feb 24 2100")
+      Time.stub!(:now).and_return(@time_now)
+      @session.cache["/forces/"].should be_nil
+    end
+  end
+end

data/spec/session/create_spec.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "Session" do
+  describe "when creating, .create" do
+    it "should be cool when supplying an api key" do
+      OldBill::Session.create(:username => ENV["OLD_BILL_USERNAME"], :password => ENV["OLD_BILL_PASSWORD"])
+    end
+    
+    it "should have the defaults" do
+      session = OldBill::Session.create(:username => ENV["OLD_BILL_USERNAME"], :password => ENV["OLD_BILL_PASSWORD"])
+      session.server.should == "policeapi2.rkh.co.uk/api"
+      session.api_version.should == 2
+      session.logging.should be_false
+      session.caching.should be_true
+    end
+    
+    it "should allow defaults to be changed when creating" do
+      session = OldBill::Session.create(:username => ENV["OLD_BILL_USERNAME"], :password => ENV["OLD_BILL_PASSWORD"], :api_version => 3, :logging => false, :server => "beans")
+      session.server.should == "beans"
+      session.logging.should be_false
+      session.api_version.should == 3
+    end
+    
+    it "should raise Argument error if no api key is supplied; with message 'need API to save the planet!'" do
+      lambda{OldBill::Session.create}.should raise_error(ArgumentError)
+    end
+  end
+end

data/spec/session/crime_spec.rb

@@ -0,0 +1,121 @@
+# encoding: utf-8
+require File.expand_path("../../spec_helper", __FILE__)
+require File.expand_path('../../vcr_enabled', __FILE__)
+
+describe "crime api" do
+  use_vcr_cassette 'share', :record => :new_episodes
+  context "#forces" do
+    before(:each) do
+      @session = OldBill::Session.create(:username => ENV["OLD_BILL_USERNAME"], :password => ENV["OLD_BILL_PASSWORD"])
+    end
+  
+    it "should be cool in getting some forces" do
+      lambda{@session.forces}.should_not raise_error
+    end
+  
+    it "should include bedfordshire as one of its forces do" do
+      forces = @session.forces
+      forces.detect{|force| force.id == "bedfordshire"}.should_not be_nil
+    end
+  
+    it "should have each force with a name and an id" do
+      @session.forces.each do |force|
+        force.should respond_to(:id)
+        force.should respond_to(:name)
+      end
+    end
+  end
+  
+  
+  context "#force" do
+    before(:each) do
+      @session = OldBill::Session.create(:username => ENV["OLD_BILL_USERNAME"], :password => ENV["OLD_BILL_PASSWORD"])
+    end
+  
+    it "should be cool a call force" do
+      lambda{@session.force("bedfordshire")}.should_not raise_error
+    end
+  
+    it "should be cool to get bedfordshire" do
+     @session.force("bedfordshire").should_not be_nil
+    end
+    
+    it "should have some engagement-methods" do
+      force = @session.force("bedfordshire")
+      force.engagement_methods.should_not be_empty
+    end
+    
+    it "should have engagement_methods as a hashie mash" do
+      force = @session.force("bedfordshire")
+      force.engagement_methods[0].class.should eq(Hashie::Mash)
+    end
+    
+    it "should have engagement_methods with title url description" do
+      force = @session.force("bedfordshire")
+      force.engagement_methods.each do |engagement_method|
+        engagement_method.should respond_to(:title)
+        engagement_method.should respond_to(:url)
+        engagement_method.should respond_to(:description)
+      end
+    end
+  end
+  
+  context "#crimes_by_month" do
+    before(:each) do
+      @session = OldBill::Session.create(:username => ENV["OLD_BILL_USERNAME"], :password => ENV["OLD_BILL_PASSWORD"])
+    end
+    
+    it "should cool to call crimes_by_month" do
+      lambda{@session.crimes_by_month("leicestershire", "C01")}.should_not raise_error
+    end
+    
+    it "should bring back empty array when no data" do
+      @session.crimes_by_month("bedfordshire", "C01").should be_empty
+    end
+    
+    it "should create a nice looking crime by month object" do
+      crime_by_month = @session.crimes_by_month("leicestershire", "C01")[0]
+      crime_by_month.month.should_not be_empty
+      crime_by_month.burglary.should_not be_empty
+    end
+  end
+
+  context "#street_level_crimes" do
+    before(:each) do
+      @session = OldBill::Session.create(:username => ENV["OLD_BILL_USERNAME"], :password => ENV["OLD_BILL_PASSWORD"])
+    end
+    
+    it "should cool to call street_level_crimes" do
+      lambda{@session.street_level_crimes(51, 48)}.should_not raise_error
+    end
+    
+    it "should bring back empty array when no data" do
+      @session.street_level_crimes(0, 0).should be_empty
+    end
+    
+    it "should create a nice looking street_level_crimes object" do
+      street_crimes = @session.street_level_crimes(52.6397278, -1.1322921)
+      street_crime = street_crimes[0]
+      street_crime.category.should_not be_nil
+      street_crime.month.should_not be_nil
+      street_crime.location.should_not be_nil
+      street_crime.location.street.name.should_not be_nil
+    end
+  end
+  
+  context "#crime_categories" do
+    before(:each) do
+      @session = OldBill::Session.create(:username => ENV["OLD_BILL_USERNAME"], :password => ENV["OLD_BILL_PASSWORD"])
+    end
+    
+    it "should be cool to call crime_categories" do
+      lambda{@session.crime_categories}.should_not raise_error
+    end
+    
+    it "should include bulgary as one of its categories" do
+      categories = @session.crime_categories
+      categories.detect{|category| category.url == "burglary"}.should_not be_nil
+    end
+  end
+  
+end

data/spec/session/neighbourhoods_spec.rb

@@ -0,0 +1,131 @@
+# encoding: utf-8
+require File.expand_path("../../spec_helper", __FILE__)
+require File.expand_path('../../vcr_enabled', __FILE__)
+
+describe "crime api" do
+  use_vcr_cassette 'share', :record => :new_episodes
+  
+  context "#neighbourhoods" do
+    before(:each) do
+      @session = OldBill::Session.create(:username => ENV["OLD_BILL_USERNAME"], :password => ENV["OLD_BILL_PASSWORD"])
+    end
+    
+    it "should be cool to call neighbourhoods" do
+      lambda{@session.neighbourhoods("leicestershire")}.should_not raise_error
+    end
+    
+    it "should give me some cool neighbourhoods" do
+      neighbourhood = @session.neighbourhoods("leicestershire")[0]
+      neighbourhood.name.should_not be_nil
+      neighbourhood.id.should_not be_nil
+      neighbourhood.should_not be_fully_loaded
+    end
+    
+    it "should be able to come fully_loaded" do
+      neighbourhood = @session.neighbourhoods("leicestershire")[0]
+      neighbourhood.fully_loaded!
+      neighbourhood.centre.latitude.should_not be_nil
+    end
+    
+    it "should raise 404 when random force" do
+      lambda{@session.neighbourhoods("random")}.should raise_error(OldBill::NotFoundError)
+    end
+  end
+  
+  context "#neighbourhood" do
+    before(:each) do
+      @session = OldBill::Session.create(:username => ENV["OLD_BILL_USERNAME"], :password => ENV["OLD_BILL_PASSWORD"])
+    end
+    
+    it "should be cool to call neighbourhoods" do
+      lambda{@session.neighbourhood("leicestershire", "C01")}.should_not raise_error
+    end
+    
+    it "should give me a cool neighbourhood" do
+      neighbourhood = @session.neighbourhoods("leicestershire")[0]
+      neighbourhood.fully_loaded!
+      neighbourhood.centre.latitude.should_not be_nil
+      neighbourhood.contact_details.should_not be_empty
+      neighbourhood.contact_details.email.should_not be_nil
+    end
+    
+    it "should be cool to get some crimes" do
+      neighbourhood = @session.neighbourhoods("leicestershire")[0]
+      neighbourhood.street_level_crimes.should_not be_empty
+      neighbourhood.street_level_crimes[0].category.should_not be_empty
+    end
+  end
+  
+  context "#events" do
+    before(:each) do
+      @session = OldBill::Session.create(:username => ENV["OLD_BILL_USERNAME"], :password => ENV["OLD_BILL_PASSWORD"])
+    end
+    
+    it "should be cool to call events" do
+      lambda{@session.events("leicestershire", "C01")}.should_not raise_error
+    end
+    
+    it "should give me a cool event" do
+      event = @session.events("leicestershire", "C01")[0]
+      event.start_date.should_not be_nil
+      event.start_date.should be_a(Date)
+      event.description.should_not be_nil
+    end
+  end
+  
+  context "#police_officers" do
+    before(:each) do
+      @session = OldBill::Session.create(:username => ENV["OLD_BILL_USERNAME"], :password => ENV["OLD_BILL_PASSWORD"])
+    end
+    
+    it "should be cool to call events" do
+      lambda{@session.police_officers("leicestershire", "C01")}.should_not raise_error
+    end
+    
+    it "should give me a cool event" do
+      police_officer = @session.police_officers("leicestershire", "C01")[0]
+      police_officer.bio.should_not be_nil
+      police_officer.name.should.should_not be_nil
+      police_officer.rank.should.should_not be_nil
+    end
+  end
+  
+  context "#locate" do
+    before(:each) do
+      @session = OldBill::Session.create(:username => ENV["OLD_BILL_USERNAME"], :password => ENV["OLD_BILL_PASSWORD"])
+    end
+    
+    it "should be cool to call events" do
+      lambda{@session.locate(52.6397278, -1.1322921)}.should_not raise_error
+    end
+    
+    it "should bring back nil when no location found" do
+      @session.locate(33, -1).should be_nil
+    end
+    
+    it "should give me a cool locator" do
+      locator = @session.locate(52.6397278, -1.1322921)
+      locator.neighbourhood.should_not be_nil
+      locator.force.should_not be_nil
+    end
+    
+    it "should be cool to get crimes_by_month" do
+      locator = @session.locate(52.6397278, -1.1322921)
+      locator.crimes_by_month.should_not be_empty
+      locator.crimes_by_month[0].month.should_not be_nil
+    end
+    
+    
+    it "should be cool to get police_officers" do
+      locator = @session.locate(52.6397278, -1.1322921)
+      locator.police_officers.should_not be_empty
+      locator.police_officers[0].rank.should_not be_nil
+    end
+    
+    it "should be cool to get events" do
+      locator = @session.locate(52.6397278, -1.1322921)
+      locator.events.should_not be_empty
+      locator.events[0].description.should_not be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require "bundler"
+Bundler.setup
+
+# get the calculated gem and bundle in the test group
+require "oldbill"
+Bundler.require(:test)
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+Rspec.configure do |config|
+  config.before(:suite) do
+    raise Exception, "You need to set you old bill mate" unless ENV["OLD_BILL_USERNAME"] && ENV["OLD_BILL_PASSWORD"]  
+  end
+  
+   config.before(:each) do
+   end
+   
+  config.mock_with :rspec
+end

data/spec/vcr_enabled.rb

@@ -0,0 +1,11 @@
+require 'vcr'
+require 'webmock'
+
+VCR.config do |c|
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.stub_with :webmock # :fakeweb
+end
+
+RSpec.configure do |c|
+  c.extend VCR::RSpec::Macros
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification 
+name: oldbill
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- hookercookerman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-23 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 5
+        version: 3.0.5
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        version: "0.5"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        - 4
+        version: 0.7.4
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: moneta
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: tzinfo
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 22
+        version: 0.3.22
+  type: :runtime
+  version_requirements: *id006
+description: ruby wrapper for the police API
+email: 
+- hookercookerman@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- README.rdoc
+- Rakefile
+- autotest/discover.rb
+- lib/oldbill.rb
+- lib/oldbill/api/crime.rb
+- lib/oldbill/api/neighbourhood.rb
+- lib/oldbill/errors.rb
+- lib/oldbill/service.rb
+- lib/oldbill/session.rb
+- lib/oldbill/v2/crime_by_month.rb
+- lib/oldbill/v2/crimes/location.rb
+- lib/oldbill/v2/crimes/street_level.rb
+- lib/oldbill/v2/force.rb
+- lib/oldbill/v2/neighbourhood.rb
+- lib/oldbill/v2/neighbourhoods/event.rb
+- lib/oldbill/v2/neighbourhoods/location.rb
+- lib/oldbill/v2/neighbourhoods/locator.rb
+- lib/oldbill/v2/neighbourhoods/police_officer.rb
+- lib/oldbill/version.rb
+- oldbill.gemspec
+- spec/fixtures/vcr_cassettes/share.yml
+- spec/session/cache_spec.rb
+- spec/session/create_spec.rb
+- spec/session/crime_spec.rb
+- spec/session/neighbourhoods_spec.rb
+- spec/spec_helper.rb
+- spec/vcr_enabled.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: oldbill
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: ruby wrapper for the police API
+test_files: 
+- spec/fixtures/vcr_cassettes/share.yml
+- spec/session/cache_spec.rb
+- spec/session/create_spec.rb
+- spec/session/crime_spec.rb
+- spec/session/neighbourhoods_spec.rb
+- spec/spec_helper.rb
+- spec/vcr_enabled.rb