citibikenyc 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 07aeb5ee83325ec495e5a2a452d7548e214fe98a
+  data.tar.gz: 9e8630dba61d0850a7634e105dbcf712daa8de63
+SHA512:
+  metadata.gz: aff897cf93ba7d222f1ac742effdf2c16368c221df6c7c8c93a6f2b80049b4efd60450ad739dc902b87dd48346371a66ae99cf1debf319f304f9e50fc25210b7
+  data.tar.gz: cf669aa4c87de7a3d89d25f1ce1a8a9153acc2fd517c3ba15d3f80510135c95f67e839e449ea5dd2e9ae29f292a476e48b4e6eaaa3cf13399d4940f451631d4e

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+.ruby-version
+.ruby-gemset
+Gemfile.lock
+.DS_Store
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Edgar Gonzalez
+
+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,69 @@
+# Citibikenyc [![Build Status](https://travis-ci.org/edgar/citibikenyc.png?branch=master)](https://travis-ci.org/edgar/citibikenyc) [![Dependency Status](https://gemnasium.com/edgar/citibikenyc.png)](https://gemnasium.com/edgar/citibikenyc)
+A gem for CitibikeNYC API - citibikenyc.com
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'citibikenyc'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install citibikenyc
+
+## API Usage Examples
+
+    require "rubygems"
+    require "citibikenyc"
+
+    # Get a list of all stations
+    puts Citibikenyc.stations
+
+    # Get only the current status for all stations
+    puts Citibikenyc.stations_status
+
+    # Get helmets info
+    puts Citibikenyc.helmets
+
+    # Get branches info
+    puts Citibikenyc.branches
+
+For more information about the data returned by every method please check the specs folder
+
+## Configuration
+
+Because citibikenyc gem is based on [Faraday](https://github.com/lostisland/faraday), it supports the following adapters:
+
+* Net::HTTP (default)
+* [Excon][https://github.com/geemus/excon]
+* [Typhoeus][https://github.com/typhoeus/typhoeus]
+* [Patron][http://toland.github.com/patron/]
+* [EventMachine][https://github.com/igrigorik/em-http-request]
+
+Beside the adapter, you can change the following properties:
+
+* endpoint
+* format
+* user_agent
+* proxy
+* debug
+
+For instance:
+
+    require 'typhoeus/adapters/faraday' # You will need the typhoeus gem
+
+    client = Citibikenyc.client(adapter: :typhoeus, user_agent: "foobar v1", debug: true)
+    client.stations
+
+
+## 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,30 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+task :default => :spec
+task :test => :spec
+
+namespace :doc do
+  begin
+    require 'yard'
+  rescue LoadError
+    # ignore
+  else
+    YARD::Rake::YardocTask.new do |task|
+      task.files   = ['lib/**/*.rb']
+      task.options = [
+        '--protected',
+        '--output-dir', 'doc/yard',
+        '--tag', 'format:Supported formats',
+        '--markup', 'markdown',
+      ]
+    end
+  end
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r citibikenyc.rb"
+end

data/citibikenyc.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/citibikenyc/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency('rspec', '~> 2.13.0')
+  gem.add_development_dependency('webmock', '~> 1.12.3')
+  gem.add_development_dependency('yard', '~> 0.8.6.2')
+  gem.add_development_dependency('bluecloth', '~> 2.2.0')
+  gem.add_runtime_dependency('faraday', '~> 0.8.7')
+  gem.add_runtime_dependency('faraday_middleware', '~> 0.9.0')
+  gem.add_runtime_dependency('multi_json', '~> 1.7.7')
+  gem.add_runtime_dependency('hashie',  '~> 2.0.5')
+  gem.authors       = ["Edgar Gonzalez"]
+  gem.email         = ["edgargonzalez@gmail.com"]
+  gem.description   = %q{A ruby wrapper for Citibikenyc API}
+  gem.homepage      = "http://github.com/edgar/citibikenyc"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.summary       = %q{A ruby wrapper for Citibikenyc API}
+  gem.name          = "citibikenyc"
+  gem.require_paths = ["lib"]
+  gem.version       = Citibikenyc::VERSION.dup
+end

data/lib/citibikenyc.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../citibikenyc/error', __FILE__)
+require File.expand_path('../citibikenyc/configuration', __FILE__)
+require File.expand_path('../citibikenyc/api', __FILE__)
+require File.expand_path('../citibikenyc/client', __FILE__)
+
+module Citibikenyc
+  extend Configuration
+
+  # Alias for Citibikenyc::Client.new
+  #
+  # @return [Citibikenyc::Client]
+  def self.client(options={})
+    Citibikenyc::Client.new(options)
+  end
+
+  # Delegate to Citibikenyc::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+  # Delegate to Citibikenyc::Client
+  def self.respond_to?(method)
+    return client.respond_to?(method) || super
+  end
+end

data/lib/citibikenyc/api.rb

@@ -0,0 +1,21 @@
+require File.expand_path('../connection', __FILE__)
+require File.expand_path('../request', __FILE__)
+
+module Citibikenyc
+  # @private
+  class API
+    # @private
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API
+    def initialize(options={})
+      options = Citibikenyc.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    include Connection
+    include Request
+  end
+end

data/lib/citibikenyc/client.rb

@@ -0,0 +1,10 @@
+module Citibikenyc
+  class Client < API
+
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each{|f| require f}
+
+    include Citibikenyc::Client::Stations
+    include Citibikenyc::Client::Helmets
+    include Citibikenyc::Client::Branches
+  end
+end

data/lib/citibikenyc/client/branches.rb

@@ -0,0 +1,24 @@
+module Citibikenyc
+  class Client
+    # Defines methods related to branches
+    module Branches
+
+      # Returns all information about branches
+      #
+      # @param options [Hash] An optional options hash
+      # @return [Hashie::Mash]
+      # @example Return all information about the branches
+      #   Citibikenyc.branches
+      # @format :json
+      def branches(options={})
+        get(branches_path, options)
+      end
+
+      protected
+
+      def branches_path
+        'v1/branch/list'
+      end
+    end
+  end
+end

data/lib/citibikenyc/client/helmets.rb

@@ -0,0 +1,24 @@
+module Citibikenyc
+  class Client
+    # Defines methods related to helmets
+    module Helmets
+
+      # Returns all information about helmets
+      #
+      # @param options [Hash] An optional options hash
+      # @return [Hashie::Mash]
+      # @example Return all information about the helmets
+      #   Citibikenyc.helmets
+      # @format :json
+      def helmets(options={})
+        get(helmets_path, options)
+      end
+
+      protected
+
+      def helmets_path
+        'v1/helmet/list'
+      end
+    end
+  end
+end

data/lib/citibikenyc/client/stations.rb

@@ -0,0 +1,35 @@
+module Citibikenyc
+  class Client
+    # Defines methods related to stations
+    module Stations
+
+      # Returns all information about stations
+      #
+      # @param options [Hash] An optional options hash
+      # @return [Hashie::Mash]
+      # @example Return all information about the stations
+      #   Citibikenyc.stations
+      # @format :json
+      def stations(options={})
+        get(stations_path, options)
+      end
+
+      # Returns only the stations status
+      #
+      # @param options [Hash] An optional options hash
+      # @return [Hashie::Mash]
+      # @example Returns only the stations status
+      #   Citibikenyc.stations_status
+      # @format :json
+      def stations_status(options={})
+        get(stations_path, options.merge(:updateOnly => true))
+      end
+
+      protected
+
+      def stations_path
+        'data2/stations.php'
+      end
+    end
+  end
+end

data/lib/citibikenyc/configuration.rb

@@ -0,0 +1,78 @@
+require 'faraday'
+require File.expand_path('../version', __FILE__)
+
+module Citibikenyc
+  # Defines constants and methods related to configuration
+  module Configuration
+    # An array of valid keys in the options hash when configuring a {Citibikenyc::API}
+    VALID_OPTIONS_KEYS = [
+      :adapter,
+      :endpoint,
+      :format,
+      :user_agent,
+      :proxy,
+      :debug
+    ].freeze
+
+    # An array of valid request/response formats
+    VALID_FORMATS = [
+      :json].freeze
+
+    # The adapter that will be used to connect if none is set
+    #
+    # @note The default faraday adapter is Net::HTTP.
+    DEFAULT_ADAPTER = Faraday.default_adapter
+
+    # By default, don't set an application ID
+    DEFAULT_CLIENT_ID = nil
+
+    # The endpoint that will be used to connect if none is set
+    #
+    # @note There is no reason to use any other endpoint at this time
+    DEFAULT_ENDPOINT = 'http://appservices.citibikenyc.com/'.freeze
+
+    # The response format appended to the path and sent in the 'Accept' header if none is set
+    #
+    # @note JSON is the only available format at this time
+    DEFAULT_FORMAT = :json
+
+    # By default, don't use a proxy server
+    DEFAULT_PROXY = nil
+
+    # By default, dont' log the request/response
+    DEFAULT_DEBUG = false
+
+    # The user agent that will be sent to the API endpoint if none is set
+    DEFAULT_USER_AGENT = "Citibikenyc #{Citibikenyc::VERSION}".freeze
+
+    # @private
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.adapter        = DEFAULT_ADAPTER
+      self.endpoint       = DEFAULT_ENDPOINT
+      self.format         = DEFAULT_FORMAT
+      self.user_agent     = DEFAULT_USER_AGENT
+      self.proxy          = DEFAULT_PROXY
+      self.debug          = DEFAULT_DEBUG
+    end
+  end
+end

data/lib/citibikenyc/connection.rb

@@ -0,0 +1,27 @@
+require 'faraday_middleware'
+Dir[File.expand_path('../../faraday/*.rb', __FILE__)].each{|f| require f}
+
+module Citibikenyc
+  # @private
+  module Connection
+    private
+
+    def connection(raw=false)
+      options = {
+        :headers => {'Accept' => "application/json; charset=utf-8", 'User-Agent' => user_agent},
+        :proxy => proxy,
+        :ssl => {:verify => false},
+        :url => endpoint,
+      }
+
+      Faraday::Connection.new(options) do |connection|
+        connection.use Faraday::Request::UrlEncoded
+        connection.use FaradayMiddleware::Mashify unless raw
+        connection.use Faraday::Response::ParseJson unless raw
+        connection.use FaradayMiddleware::RaiseHttpException
+        connection.use Faraday::Response::Logger if debug
+        connection.adapter(adapter)
+      end
+    end
+  end
+end