sncf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 67268cd1f99364185d187b698ad29e74410b89ec
+  data.tar.gz: 9de2b1a2935e201953c344b0a836e6ea31458b2c
+SHA512:
+  metadata.gz: 736b834f00c37a36121512ead4bb49162f553e08b288b02c4cc2f6ba9ab2d8fd6d46242a137bc0011e47305d95f6a601377fd5465cf37a02b58db6ebeee600c9
+  data.tar.gz: 4e8b605ae94267cc83f591d1dd476456dd83e41cebaa51fd42e9256e8163408f6edaf1de311a33b545d14d1aee43d52ed4ca16fb6bb8801a54f1a04933f313b9

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+.rvmrc
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+.ruby-gemset
+.ruby-version

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.2.1

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Lock bundler here to help travis to work correctly
+gem 'bundler', '>= 1.7'
+# Specify your gem's dependencies in sncf_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Rémi Delhaye
+
+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,54 @@
+# Sncf ruby API
+
+Ruby gem to use easily the SNCF Open Data API with Ruby.
+
+API Documentation is available [here](https://data.sncf.com/api)
+
+You don't already have an API KEY ? [Register here!](https://data.sncf.com/api/register)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sncf'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sncf
+
+## Usage
+
+```ruby
+require 'sncf'
+
+# Create your Sncf::ApiClient with your API_KEY
+client = Sncf::ApiClient.new('MY_API_KEY')
+
+client.api_key
+=> 'MY_API_KEY'
+
+response = req.fetch('coverage')
+=> #<Sncf::ApiResponse:0x007f8b0592abe8
+  @body        = #<HTTP::Response::Body:3fc582c9818c @streaming=true>,
+  @content     = { ... }, # Here is the api response
+  @pagination  = nil,
+  @response    = #<HTTP::Response/1.1 200 OK ...>,
+  @start_page  = 0>
+
+```
+
+Available `fetch` parameters and API actions are here [https://data.sncf.com/api/documentation#title.1.2.3](https://data.sncf.com/api/documentation#title.1.2.3)
+
+## Contributing
+
+1. Fork it ( https://github.com/rdlh/sncf/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sncf_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start
+

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sncf/api_client.rb

@@ -0,0 +1,53 @@
+require 'http'
+require 'oj'
+
+module Sncf
+  class ApiClient
+    HOST_URL          = 'https://api.sncf.com'
+    BASE_PATH         = 'v1'
+    PLAN = {
+      name: 'Free',
+      limits: {
+        per_day: 3_000,
+        per_month: 90_000
+      }
+    }
+
+    # => 3aa53f6d-13f1-486b-8a68-a781842cbe73
+
+    attr_reader :api_key
+
+    def initialize(api_key)
+      if !api_key.is_a?(String) || api_key.strip == ''
+        raise ArgumentError, "You must specify your SNCF api_key as a non-empty string."
+      else
+        @api_key = api_key
+      end
+    end
+
+    def quotas
+      @quotas ||= begin
+        { per_day: PLAN[:limits][:per_day], per_month: PLAN[:limits][:per_month] }
+      end
+    end
+
+    def fetch(path, additional_params = nil)
+      query     = construct_formated_url path, additional_params
+      response  = Http.basic_auth(user: @api_key, pass: nil).get query
+      if response.code == 200
+        Sncf::ApiResponse.new response, query
+      else
+        raise ArgumentError, "Unauthorized (#{response.code}) #{response.body}"
+      end
+    end
+
+    protected
+
+    def construct_formated_url(path, additional_params)
+      if additional_params.nil?
+        "#{HOST_URL}/#{BASE_PATH}/#{path}"
+      else
+        "#{HOST_URL}/#{BASE_PATH}/#{path}?#{additional_params.to_query}"
+      end
+  end
+end

data/lib/sncf/api_response.rb

@@ -0,0 +1,24 @@
+require 'http'
+require 'oj'
+module Sncf
+  class ApiResponse
+    attr_reader :response, :body, :content, :pagination, :start_page
+
+    def initialize(response, query)
+      @response = response
+      @query    = query
+      @body     = @response.body
+      @content  = ''
+      loop do
+        chunk = @body.readpartial(HTTP::Connection::BUFFER_SIZE) rescue nil
+        break if chunk.nil?
+        @content << chunk
+      end
+      if @response.content_type.mime_type == 'application/json'
+        @content = Oj.load(@content)
+        @pagination = @content['pagination']
+        @start_page = @pagination ? @pagination['start_page'] : 0
+      end
+    end
+  end
+end

data/lib/sncf/version.rb

@@ -0,0 +1,3 @@
+module Sncf
+  VERSION = "0.1.0"
+end

data/lib/sncf.rb

@@ -0,0 +1,6 @@
+require 'sncf/version'
+require 'sncf/api_client'
+require 'sncf/api_response'
+
+module Sncf
+end

data/sncf.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sncf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sncf"
+  spec.version       = Sncf::VERSION
+  spec.authors       = ["Rémi Delhaye"]
+  spec.email         = ["remi@libertrip.com"]
+
+  spec.summary       = %q{SNCF open data API ruby gem}
+  spec.description   = %q{SNCF open source API. Documentation here: https://data.sncf.com/api/documentation }
+  spec.homepage      = "https://github.com/rdlh/sncf"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split("\n").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_runtime_dependency "http", "~> 0.8.12"
+  spec.add_runtime_dependency "oj", "~> 2.12"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "guard-rspec", "~> 4.5"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "byebug", "~> 4.0"
+  spec.add_development_dependency "pry-byebug", "~> 3.1"
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: sncf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rémi Delhaye
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.12
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: 'SNCF open source API. Documentation here: https://data.sncf.com/api/documentation '
+email:
+- remi@libertrip.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sncf.rb
+- lib/sncf/api_client.rb
+- lib/sncf/api_response.rb
+- lib/sncf/version.rb
+- sncf.gemspec
+homepage: https://github.com/rdlh/sncf
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: SNCF open data API ruby gem
+test_files: []