idbus_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a8d04adf19e8cd56f2bdc02564303cada23a6364
+  data.tar.gz: 5ad55361ad7fef7920202e4d1547d8cc521f3836
+SHA512:
+  metadata.gz: ced582baf89e79f8dfea0c21450f689335eb0b9570ee34820bea2bae79fa73ea8d0515f69b10b1a361085c254224688f9dd8363d81d22ff5a60d7e1dbd492d4a
+  data.tar.gz: 50731a514b3636e56f326f47c47fa16268abeb130c875dee86d6d6d1619f10b4d4109b91d9c8b0915fe1eb12715257326b77f8f7d6af0cf87bb8ec8c68cebdab

data/.gitignore

@@ -0,0 +1,10 @@
+pkg/*
+doc/*
+rdoc/*
+*.gem
+.bundle
+Gemfile.lock
+.gh_pages
+coverage/
+*#*
+*~

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,36 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-06-01 12:18:38 +0200 using RuboCop version 0.22.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+ClassLength:
+  Max: 142
+
+# Offense count: 1
+CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 5
+Documentation:
+  Enabled: false
+
+# Offense count: 53
+LineLength:
+  Max: 704
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+MethodLength:
+  Max: 19
+
+# Offense count: 2
+MultilineBlockChain:
+  Enabled: false
+
+# Offense count: 5
+RescueModifier:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+
+notifications:
+  email: false
+
+rvm:
+  - 2.0
+  - 2.1
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+
+before_install:
+  - gem install fakeweb
+
+script:
+  - "bundle exec rake spec"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+gem "api", "~> 0.0.2", :git => "https://github.com/paulrbr/api.git"

data/Guardfile

@@ -0,0 +1,6 @@
+group 'gem' do
+  guard 'rspec', :cmd => "bundle exec rspec", :all_on_start => false, :all_after_pass => false, :failed_mode => :focus do
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/idbus_api/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  end
+end

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2015 Paul Bonaud
+
+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,102 @@
+# iDBUS API wrapper
+
+[![Build Status](https://travis-ci.org/paulRbr/idbus_api.svg)](https://travis-ci.org/paulRbr/idbus_api) [![Coverage Status](https://coveralls.io/repos/paulRbr/idbus_api/badge.svg)](https://coveralls.io/r/paulRbr/idbus_api)
+
+## Description
+
+This gem wraps the new iDBUS API v1 available at https://api.idbus.com
+
+## Installation
+
+You can use this gem in your project by specifying it in your `Gemfile`:
+
+```
+gem "idbus_api"
+```
+
+or simply install it via the CLI:
+
+```
+gem install idbus_api
+```
+
+## Usage
+
+All the API methods are available as module methods or as client instance methods.
+
+### Configure the client
+
+```
+IdbusApi.configure do |c|
+  c.access_token = "my_secret_token"
+  c.connection_options = {
+    ssl: { verify: false }
+  } # Hash of Faraday ConnectionOptions. See http://www.rubydoc.info/github/lostisland/faraday/Faraday/Connection#initialize-instance_method
+  c.user_agent = "My App"
+end
+
+# Fetch all stops
+IdbusApi.stops
+```
+
+or
+
+```
+client = IdbusApi::Client.new(
+  access_token: "my_secret_token",
+  user_agent: "My App"
+)
+
+# Fetch fares
+client.fares(date: "2015-07-07")
+```
+
+### Fetching resources
+
+All resources are `Resource` objects. This object provides both dot notation and `[]` access for the api response fields.
+
+#### Stops
+
+```
+# Fetch stops from /v1/stops endpoint
+stops = IdbusApi.stops
+
+stops.first.short_name == "Paris CDG (aéroport)"
+```
+
+#### Fares
+
+Fares can be fetched with optional parameters. Full list of available parameters is available on the api documentation https://api.idbus.com/.
+
+```
+# Fetch fares for specific origin station and specific date
+fares = IdbusApi.fares(origin_id: 3, date: "2015-08-15")
+
+fares.first.price_cents
+ => 1500
+
+fares.first.to_hash
+ => {
+      :id => 13864,
+      :updated_at => 2015-06-11 07:55:22 UTC,
+      :origin_id => 3,
+      :destination_id => 13,
+      :departure => "2015-08-15T08:40:00.000+02:00",
+      :arrival => "2015-08-15T12:55:00.000+02:00",
+      :price_cents => 1500,
+      :price_currency => "EUR",
+      :book_path => "/v1/fares/13864/book",
+      :available => true,
+      :legs => [{:origin_id=>3, :destination_id=>13, :departure=>"2015-08-15T08:40:00.000+02:00", :arrival=>"2015-08-15T12:55:00.000+02:00", :bus_number=>"3912"}]
+    }
+```
+
+## Disclaimer
+
+Neither I, nor any developer who contributed to this project, accept any kind of liability for your use of this library.
+
+_This gem is not endorsed or affiliated with any company, api.idbus.com, nor iDBUS, nor SNCF._
+
+## License
+
+Code licensed under [MIT-LICENSE](https://github.com/paulrbr/idbus_api/blob/master/MIT-LICENSE)

data/Rakefile

@@ -0,0 +1,25 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+require 'idbus_api/version'
+require 'rdoc/task'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.main = 'README.rdoc'
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "IdbusApi #{IdbusApi::VERSION} documentation"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.options << '--webcvs=http://github.com/paulrbr/idbus_api/tree/master/'
+end
+
+require 'gokdok'
+Gokdok::Dokker.new do |gd|
+  gd.repo_url = 'git@github.com:paulrbr/idbus_api.git'
+  gd.doc_home = 'rdoc'
+  gd.remote_path = '.'
+end

data/idbus_api.gemspec

@@ -0,0 +1,35 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'idbus_api/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'idbus_api'
+  s.licenses    = ['MIT']
+  s.version     = IdbusApi::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Paul Bonaud']
+  s.email       = ['paul+gh@bonaud.fr']
+  s.homepage    = 'http://github.com/paulrbr/idbus_api'
+  s.summary     = %q(Easily access the API of iDBUS.)
+  s.description = %q(Easily use Ruby or the command line to find information from the iDBUS API.)
+
+  s.rubyforge_project = 'idbus_api'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'api'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'vcr'
+  s.add_development_dependency 'multi_json'
+  s.add_development_dependency 'gokdok'
+  s.add_development_dependency 'guard'
+  s.add_development_dependency 'guard-rspec'
+  s.add_development_dependency 'rdoc'
+  s.add_development_dependency 'fakeweb'
+  s.add_development_dependency 'coveralls'
+end

data/lib/idbus_api.rb

@@ -0,0 +1,49 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__)) unless
+  $LOAD_PATH.include?(File.dirname(__FILE__)) || $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+require 'json'
+
+require 'api'
+
+require 'idbus_api/default'
+require 'idbus_api/client'
+#require 'idbus_api/base'
+#require 'idbus_api/stop'
+#require 'idbus_api/fare'
+require 'idbus_api/version'
+
+
+# Ruby toolkit for the iDBUS API
+module IdbusApi
+
+  class << self
+
+    include Api::Configurable
+
+    # API client based on configured options {Configurable}
+    #
+    # @return [IdbusApi::Client] API wrapper
+    def client
+      return @client if defined?(@client) && @client.same_options?(options)
+      @client = IdbusApi::Client.new(options)
+    end
+
+    private
+
+    def respond_to_missing?(method_name, include_private = false)
+      client.respond_to?(method_name, include_private)
+    end
+
+    def method_missing(method_name, *args, &block)
+      if client.respond_to?(method_name)
+        return client.send(method_name, *args, &block)
+      end
+
+      super
+    end
+
+  end
+end
+
+IdbusApi.reset!

data/lib/idbus_api/client.rb

@@ -0,0 +1,29 @@
+require 'api/authentication'
+require 'api/configurable'
+require 'api/connection'
+
+require 'idbus_api/errors'
+require 'idbus_api/endpoint/stops'
+require 'idbus_api/endpoint/fares'
+
+module IdbusApi
+
+  # Client for the iDBUS API
+  #
+  # @see https://api.idbus.com
+  class Client < Api::Client
+
+    # Include API gem modules
+    include Api::Authentication
+    include Api::Configurable
+    include Api::Connection
+
+    # Describe API endpoints
+    include IdbusApi::Endpoint::Stops
+    include IdbusApi::Endpoint::Fares
+
+     # Header keys that can be passed in options hash to {#get}
+    CONVENIENCE_HEADERS = Set.new([:accept, :content_type])
+
+  end
+end

data/lib/idbus_api/default.rb

@@ -0,0 +1,65 @@
+require "api/default_options"
+
+module IdbusApi
+
+  # Default configuration options for {Client}
+  module Default
+
+    # Default API endpoint
+    API_ENDPOINT = "https://api.idbus.com".freeze
+
+    # Default API version
+    API_VERSION = "v1".freeze
+
+    # Default User Agent header string
+    USER_AGENT   = "Idbus API Ruby Gem #{IdbusApi::VERSION}".freeze
+
+    class << self
+
+      include Api::DefaultOptions
+
+      # Default access token from ENV
+      # @return [String]
+      def access_token
+        ENV['IDBUS_ACCESS_TOKEN']
+      end
+
+      # Default access token prefix
+      # @return [String]
+      def access_token_prefix
+        "Token"
+      end
+
+      # Default API endpoint from ENV or {API_ENDPOINT}
+      # @return [String]
+      def api_endpoint
+        ENV['IDBUS_API_ENDPOINT'] || API_ENDPOINT
+      end
+
+      # Default API version from ENV or {API_VERSION}
+      # @return [String]
+      def api_version
+        ENV['IDBUS_API_VERSION'] || API_VERSION
+      end
+
+    # Default options for Faraday::Connection
+      # @return [Hash]
+      def connection_options
+        {
+          :headers => {
+            :user_agent => user_agent
+          }
+        }
+      end
+
+      # Default User-Agent header string from ENV or {USER_AGENT}
+      # @return [String]
+      # Default User-Agent header string from ENV or {USER_AGENT}
+      # @return [String]
+      def user_agent
+        ENV['IDBUS_USER_AGENT'] || USER_AGENT
+      end
+
+    end
+  end
+end

data/lib/idbus_api/endpoint/fares.rb

@@ -0,0 +1,31 @@
+module IdbusApi
+
+  module Endpoint
+
+    # Methods of the Fares API
+    module Fares
+
+      # Make a call to the GET /fares endpoint
+      #
+      # @param parameters [Hash] optional parameters to pass to the request
+      # @return [Array<Sawyer::Resource>]
+      def fares(parameters = {})
+        allowed_parameters = %i(
+          origin_id
+          destination_id
+          date
+          start_date
+          end_date
+          currencies
+          updated_after
+        )
+
+        wrong_parameters = parameters.keys - allowed_parameters
+        fail IdbusApi::WrongParameters, wrong_parameters unless wrong_parameters.empty?
+
+        paginate("/fares", parameters).fares
+      end
+
+    end
+  end
+end