citibike 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+spec/cassettes
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

@@ -0,0 +1,4 @@
+--order random
+--fail-fast
+-p
+-c

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in citibike.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    citibike (0.0.1)
+      faraday
+      faraday_middleware
+      yajl-ruby
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colorize (0.5.8)
+    coveralls (0.6.7)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
+    diff-lcs (1.2.4)
+    faraday (0.8.7)
+      multipart-post (~> 1.1)
+    faraday_middleware (0.9.0)
+      faraday (>= 0.7.4, < 0.9)
+    metaclass (0.0.1)
+    mime-types (1.23)
+    mocha (0.13.1)
+      metaclass (~> 0.0.1)
+    multi_json (1.7.7)
+    multipart-post (1.2.0)
+    rake (10.1.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.3)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.1)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    thor (0.18.1)
+    vcr (2.3.0)
+    yajl-ruby (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  citibike!
+  coveralls
+  mocha
+  rake
+  rspec
+  vcr

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Ethan Langevin
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ethan Langevin
+
+MIT License
+
+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,121 @@
+# Citibike - Wrapper for the unofficial Citibike NYC API
+[![Build Status](https://secure.travis-ci.org/ejlangev/citibike.png)](http://travis-ci.org/ejlangev/citibike) [![Code Climate](https://codeclimate.com/github/ejlangev/citibike.png)](https://codeclimate.com/github/ejlangev/citibike) [![Coverage Status](https://coveralls.io/repos/ejlangev/citibike/badge.png?branch=master)](https://coveralls.io/r/ejlangev/citibike)
+
+A simple gem for interacting with the city bike api.  Gives you back
+objects by default with consistently named methods for accessing data.
+Also allows easy geographical searching for nearby stations via
+latitude and longitude and as the crow flies distance.
+
+I based it partially on another gem [citibikenyc](https://github.com/edgar/citibikenyc) but wanted to design mine a bit differently/play around with the API from scratch.
+
+All contributions are welcome.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'citibike'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install citibike
+
+## Usage
+
+### Defaults
+```ruby
+  # Here's an example for stations, it also provides data about
+  # branches and helmets with more or less equivalent methods
+  helmets = Citibike.helmets
+  branches = Citibike.branches
+
+  # Returns a Citibike::Responses::Station object
+  stations = Citibike.stations
+
+  # This object contains the attributes of the response
+  stations.success?     # True if the response was successful
+  stations.last_update  # The time this data was last updated
+
+  # The response object includes Enumerable and proxies
+  # unknown methods to an underlying array
+  stations.each do |s|
+    puts s.class              # Citibike::Station
+    puts s.latitude           # Float
+    puts s.longitude          # Float
+    puts s.available_bikes    # Integer
+    puts s.available_docks    # Integer
+    puts s.id                 # Integer id
+  end
+
+  # It's also simple to find stations within a given distance
+  # (in miles) of a LAT/LONG pair (in degrees)
+  # nearby will be an array of Citibike::Station objects
+  nearby = stations.all_within(LAT, LONG, DISTANCE)
+
+  # You can do the same thing given an instance of Citibike::Station
+  # Note that the results do NOT include station itself
+  nearby = stations.all_near(station, DISTANCE)
+
+  # It's also convenient to look up results by id within the
+  # list of stations
+  station = stations.find_by_id(ID)
+
+  # It also supports a variadic version
+  stats = stations.find_by_ids(ID1, ID2,...)
+
+  # Sometimes it might be convenient to a list of stations
+  # but still retain the methods of the Citibike::Responses::Station
+  # object.
+  filtered_stations = stations.clone_with(stations.select(&:active?))
+```
+
+### Configuration
+If you want to change the default configuration for web requests it
+is simple to do so given that it is using Faraday under the hood.
+Simply create an instance of Citibike::Client and pass a hash of
+your settings overrides.
+
+```ruby
+  client = Citibike::Client.new   # initializes a default client
+
+  client.stations                 # returns Citibike::Responses::Station
+  client.helmets                  # returns Citibike::Responses::Helmet
+  client.branches                 # returns Citibike::Responses::Branch
+
+  # The simplest option is to unwrap the responses in which case they
+  # come back as a simple hash not a custom object
+  client = Citibike::Client.new(unwrapped: true)
+  client.stations                 # Instance of Hash
+
+  # Other configuration options and their default values
+  {
+    adapter: Faraday.default_adapter,
+    headers: {
+      'Accept' => 'application/json; charset=utf-8',
+      'UserAgent' => 'Citibike Gem'
+    },
+    proxy: nil,
+    ssl: {
+      verify: false
+    },
+    debug: false,          # Turns on connection logging(currently unused)
+    test: false,           # True if in a test
+    stubs: nil,            # Stubs for the test connection
+    raw: false,            # Don't process the response in any way
+    format_path: true,     # Append the format to the request path  if it lacks one
+    format: :json,         # Default format
+    url: 'http://appservices.citibikenyc.com/'
+  }
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/citibike.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'citibike/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "citibike"
+  spec.version       = Citibike::VERSION
+  spec.authors       = ["Ethan Langevin"]
+  spec.email         = ["ejl6266@gmail.com"]
+  spec.description   = %q{Client for the unofficial Citibike API in NYC}
+  spec.summary       = %q{Provides an interface for interacting with Citibike NYC data}
+  spec.homepage      = "http://github.com/ejlangev/citibike"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "mocha"
+
+  spec.add_runtime_dependency "faraday"
+  spec.add_runtime_dependency "faraday_middleware"
+  spec.add_runtime_dependency "yajl-ruby"
+end

data/lib/citibike.rb

@@ -0,0 +1,20 @@
+# encoding: UTF-8
+
+require 'citibike/version'
+require 'citibike/connection'
+require 'citibike/api'
+require 'citibike/client'
+
+# Namespace for methods of accessing real time
+# Citibike data for NYC
+module Citibike
+
+  def self.method_missing(sym, *args, &block)
+    if Citibike::Client.respond_to?(sym)
+      return Citibike::Client.send(sym, *args, &block)
+    end
+
+    super
+  end
+
+end

data/lib/citibike/api.rb

@@ -0,0 +1,82 @@
+# encoding: UTF-8
+
+module Citibike
+
+  # Base class for shared behavior between
+  # all types of objects from this api
+  class Api
+
+    Dir[File.expand_path('../apis/*.rb', __FILE__)].each { |f| require f }
+
+    # Radius of the earth in miles
+    EARTH_RADIUS = 3963.1676
+
+    attr_reader :internal_object
+
+    def initialize(data)
+      @internal_object = data
+    end
+
+    #
+    # Shortcut to access latitude
+    #
+    # @return [Float] [Object's latitude position]
+    def lat
+      self['latitude']
+    end
+
+    #
+    # Shortcut to access longitude
+    #
+    # @return [Float] [Object's longitude position]
+    def long
+      self['longitude']
+    end
+
+    #
+    # Returns the distance this object is from the given
+    # latitude and longitude.  Distance is as the crow flies.
+    #
+    # @param  lat [Float] [A latitude position]
+    # @param  long [Float] [A longitude position]
+    #
+    # @return [Float] [Distance from the input postion in miles]
+    def distance_from(lat, long)
+      dLat = self.degrees_to_radians(lat - self.latitude)
+      dLon = self.degrees_to_radians(long - self.longitude)
+
+      lat1 = self.degrees_to_radians(lat)
+      lat2 = self.degrees_to_radians(self.latitude)
+
+      a = Math.sin(dLat / 2) * Math.sin(dLat / 2) +
+          Math.sin(dLon / 2) * Math.sin(dLon / 2) *
+          Math.cos(lat1) * Math.cos(lat2)
+
+      c = 2 * Math.atan2(Math.sqrt(a), Math.sqrt(1 - a))
+
+      EARTH_RADIUS * c
+    end
+
+    # Allow access to the hash through the object
+    def [](key)
+      self.internal_object[key.to_s]
+    end
+
+    # Allow hash keys to be used as methods
+    def method_missing(sym, *args, &block)
+      if self.internal_object.key?(sym.to_s)
+        return self.internal_object[sym.to_s]
+      end
+
+      super
+    end
+
+    protected
+
+    def degrees_to_radians(deg)
+      deg * Math::PI / 180
+    end
+
+  end
+
+end

data/lib/citibike/apis/branch.rb

@@ -0,0 +1,11 @@
+module Citibike
+
+	class Branch < Api
+
+    def self.path
+      return 'v1/branch/list'
+    end
+
+	end	
+
+end

data/lib/citibike/apis/helmet.rb

@@ -0,0 +1,11 @@
+module Citibike
+
+	class Helmet < Api
+
+    def self.path
+      return 'v1/helmet/list'
+    end
+
+	end
+
+end

data/lib/citibike/apis/station.rb

@@ -0,0 +1,83 @@
+# encoding: UTF-8
+
+module Citibike
+  # Represents a Station in the Citibike system and
+  # holds the data provided from the API itself along with
+  # some convenience methods accessing it
+  class Station < Api
+
+    def self.path
+      'data2/stations.php'
+    end
+    #
+    # Returns if this station is active
+    #
+    # @return [Bool] [Stations is active or not]
+    def active?
+      self.internal_object['status'] == 'Active'
+    end
+
+    #
+    # Returns the number of available bikes at this station
+    #
+    # @return [Integer] [Number of available bikes]
+    def available_bikes
+      self['availableBikes']
+    end
+
+    #
+    # Returns the number of available docks at this station
+    #
+    # @return [Integer] [Number of available docks]
+    def available_docks
+      self['availableDocks']
+    end
+
+    #
+    # Returns the address of the station
+    #
+    # @return [String] [Address of the station]
+    def station_address
+      self['stationAddress']
+    end
+
+    #
+    # Nearby station array of hashes of the form
+    # [
+    #   {
+    #     :id => Integer,
+    #     :distance => Float
+    #   },
+    #   ...
+    # ]
+    #
+    # @return [Array] [Array of hashes of nearby stations]
+    def nearby_stations
+      self['nearbyStations']
+    end
+
+    #
+    # Returns the ids of nearby stations for
+    # easy lookup in a Citibike::Responses::Station object
+    #
+    # @return [Array] [Array of integer ids]
+    def nearby_station_ids
+      @nearby_station_ids ||= self.nearby_stations.map { |s| s['id'] }
+    end
+
+    #
+    # Returns the distance to a nearby station (in miles?)
+    # @param  id [Integer] [Id of a nearby station]
+    #
+    # @return [Float] [Distance to nearby station in miles]
+    def distance_to_nearby(id)
+      unless self.nearby_station_ids.include?(id.to_i)
+        raise "Station #{id} is not a nearby station"
+      end
+
+      sta = self.nearby_stations.find { |s| s['id'].to_i == id.to_i }
+      sta['distance']
+    end
+  end
+
+end