citibike 0.0.1

data/spec/lib/client_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe Citibike::Client do
+  context "Class Methods" do
+
+    around(:each) do |example|
+      VCR.use_cassette(:client_class, record: :new_episodes) do
+        example.run
+      end
+    end
+
+    context ".stations" do
+      it "should load a list of stations" do
+        stats = Citibike::Client.stations
+
+        stats.first.should be_a(Citibike::Station)
+        stats.first.should respond_to(:lat)
+        stats.first.should respond_to(:long)
+      end
+    end
+
+    context ".helmets" do
+      it "should load a list of helmets" do
+        helms = Citibike::Client.helmets
+
+        helms.first.should be_a(Citibike::Helmet)
+        helms.first.latitude.should_not be_nil
+        helms.first.longitude.should_not be_nil
+      end
+    end
+
+    context ".branches" do
+      it "should load a list of branches" do
+        branches = Citibike::Client.branches
+
+        branches.should be_a(Citibike::Responses::Branch)
+        branches.first.should be_a(Citibike::Branch)
+      end
+    end
+
+  end
+
+  context "Instance Methods" do
+    around(:each) do |example|
+      VCR.use_cassette(:client_instance, record: :new_episodes) do
+        example.run
+      end
+    end
+
+    let(:client) { Citibike::Client.new }
+
+    let(:unwrapped) { Citibike::Client.new(unwrapped: true)}
+
+    context "#stations" do
+      it "should get back a response object by default" do
+        stats = client.stations
+
+        stats.should be_a(Citibike::Responses::Station)
+        stats.first.should be_a(Citibike::Station)
+      end
+
+      it "should get back an array when unwrapped" do
+        stats = unwrapped.stations
+
+        stats.should be_a(Hash)
+        stats['results'].first.should be_a(Hash)
+        stats['results'].first['id'].should_not be_nil
+      end
+    end
+
+    context "#helmets" do
+      it "should get back a response object by default" do
+        stats = client.helmets
+
+        stats.should be_a(Citibike::Responses::Helmet)
+        stats.first.should be_a(Citibike::Helmet)
+      end
+
+      it "should get back an array when unwrapped" do
+        stats = unwrapped.helmets
+
+        stats.should be_a(Hash)
+        stats['results'].first.should be_a(Hash)
+        stats['results'].first['id'].should_not be_nil
+      end
+    end
+
+    context "#branches" do
+      it "should get back a response object by default" do
+        stats = client.branches
+
+        stats.should be_a(Citibike::Responses::Branch)
+        stats.first.should be_a(Citibike::Branch)
+      end
+
+      it "should get back an array when unwrapped" do
+        stats = unwrapped.branches
+
+        stats.should be_a(Hash)
+        stats['results'].first.should be_a(Hash)
+        stats['results'].first['id'].should_not be_nil
+      end
+    end
+
+  end
+end

data/spec/lib/connection_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe Citibike::Connection do
+
+  let(:stubs) do
+    Faraday::Adapter::Test::Stubs.new do |stub|
+      stub.get('/test_path.json') { [200, {}, {:a => :b}.to_json] }
+      stub.get('/test_no_format') { [200, {}, {:c => :d}.to_json] }
+      stub.get('/provider_format.xsl') { [200, {}, {:e => :f}.to_json] }
+    end
+  end
+
+  it "should append the default format (.json) and parse the json" do
+    conn = Citibike::Connection.new(
+      :adapter => :test,
+      :stubs => stubs,
+      :test => true
+    )
+    result = conn.request(:get, '/test_path')
+    result.should be_a(Hash)
+
+    result['a'].should eql('b')
+  end
+
+  it "should not append the format if format_path is false" do
+    conn = Citibike::Connection.new(
+      :adapter => :test,
+      :stubs => stubs,
+      :format_path => false,
+      :format => :xml,
+      :test => true
+    )
+
+    result = conn.request(:get, '/test_no_format')
+    result.should be_a(Hash)
+
+    result['c'].should eql('d')
+  end
+
+  it "should not append the format if one is already provided" do
+    conn = Citibike::Connection.new(
+      :adapter => :test,
+      :stubs => stubs,
+      :test => true
+    )
+
+    result = conn.request(:get, '/provider_format.xsl')
+    result.should be_a(Hash)
+
+    result['e'].should eql('f')
+  end
+
+  it "should not parse the json if raw is true" do
+    conn = Citibike::Connection.new(
+      :adapter => :test,
+      :stubs => stubs,
+      :raw => true,
+      :test => true
+    )
+
+    result = conn.request(:get, '/test_path')
+    result.should be_a(String)
+
+    result = JSON.parse(result)
+    result['a'].should eql('b')
+  end
+
+end

data/spec/lib/response_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+describe "Responses" do
+
+  around(:each) do |example|
+    VCR.use_cassette(:responses, record: :new_episodes) do
+      example.run
+    end
+  end
+
+  # Currently only the superclass has actual methods so testing
+  # on just stations is sufficient
+
+  let(:stations) { Citibike::Client.stations }
+
+  it "should provide a success? method" do
+    stations.should be_a_success
+  end
+
+  it "should parse last_update into a time" do
+    stations.last_update.should be_a(Time)
+  end
+
+  it "should be enumerable" do
+    ids = stations.collect(&:id)
+
+    ids.should be_a(Array)
+    ids.first.should be_a(Integer)
+  end
+
+  it "should be able to clone itself on a subset of its data" do
+    size = stations.size
+    actives = stations.select(&:active?)
+    actives.size.should_not eql(size)
+
+    stats2 = stations.clone_with(actives)
+    stats2.size.should eql(actives.size)
+
+    stats2.last_update.should eql(stations.last_update)
+    stats2.object_id.should_not eql(stations.object_id)
+  end
+
+  it "should be able to find another object by id" do
+    ids = stations.first.nearby_station_ids
+
+    stat = stations.find_by_id(ids.first)
+    stat.id.should eql(ids.first)
+    stat.should be_a(Citibike::Station)
+  end
+
+  it "should be able to search for multiple ids at once" do
+    ids = stations[1].nearby_station_ids
+
+    stats = stations.find_by_ids(*ids)
+    stats.collect(&:id).should eql(ids)
+  end
+
+  # This conveniently tests that the code for computing
+  # distance as the crow flies from lat/long works correctly
+  context "Geolocating" do
+
+    it "should be able to find stations in a given radius" do
+      stat = stations.first
+      dists = stat.nearby_station_ids.collect do |i|
+        stat.distance_to_nearby(i)
+      end
+
+      res = stations.all_within(stat.lat, stat.long, dists.max + 0.001)
+      res.count.should eql(stat.nearby_station_ids.size + 1)
+      ([stat.id] + stat.nearby_station_ids).sort.should eql(
+        res.collect(&:id).sort
+      )
+
+    end
+
+    it "should be able to find all stations within a given radius of another
+    station" do
+      stat = stations[1]
+      dists = stat.nearby_station_ids.collect do |i|
+        stat.distance_to_nearby(i)
+      end
+
+      res = stations.all_near(stat, dists.max + 0.001)
+      res.count.should eql(stat.nearby_station_ids.size)
+      stat.nearby_station_ids.sort.should eql(res.collect(&:id).sort)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'citibike'
+
+require 'rspec'
+require 'rspec/autorun'
+
+require 'vcr'
+require 'yajl'
+
+require 'coveralls'
+Coveralls.wear!
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :faraday
+  c.allow_http_connections_when_no_cassette = true
+end

metadata

@@ -0,0 +1,232 @@
+--- !ruby/object:Gem::Specification
+name: citibike
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ethan Langevin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Client for the unofficial Citibike API in NYC
+email:
+- ejl6266@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- citibike.gemspec
+- lib/citibike.rb
+- lib/citibike/api.rb
+- lib/citibike/apis/branch.rb
+- lib/citibike/apis/helmet.rb
+- lib/citibike/apis/station.rb
+- lib/citibike/client.rb
+- lib/citibike/connection.rb
+- lib/citibike/response.rb
+- lib/citibike/responses/branch.rb
+- lib/citibike/responses/helmet.rb
+- lib/citibike/responses/station.rb
+- lib/citibike/version.rb
+- spec/cassettes/client_class.yml
+- spec/lib/apis/station_spec.rb
+- spec/lib/citibike_spec.rb
+- spec/lib/client_spec.rb
+- spec/lib/connection_spec.rb
+- spec/lib/response_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ejlangev/citibike
+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: 1917498095343501861
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1917498095343501861
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Provides an interface for interacting with Citibike NYC data
+test_files:
+- spec/cassettes/client_class.yml
+- spec/lib/apis/station_spec.rb
+- spec/lib/citibike_spec.rb
+- spec/lib/client_spec.rb
+- spec/lib/connection_spec.rb
+- spec/lib/response_spec.rb
+- spec/spec_helper.rb