sncf_api 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b923412ac426e50bfe86de63178c89d2a90cfd9
-  data.tar.gz: 0456c4718fc589184e5871627040c0ec21a59dbc
+  metadata.gz: 32decfea52cb0ea7fe5bbc03dd9fe5ccf47c9c04
+  data.tar.gz: 4027556ee32fcb6b16c7046f10250ca4b0e490c2
 SHA512:
-  metadata.gz: 9571221d5b4e1ac0f146f6f673fef87bc09bf6091793b736dac403703a47dee79d654e6de8c6443b6a8d35b6100cd1502d814d1d3a610acbfd9e7495b26cfeb3
-  data.tar.gz: 49915d7698a0ffd4b8fb26ac2ec50e6ed24864cad0a53714a660cfb8b288ffd6a11b31336ea4382fa1c65ea762a04b88a29b91b21fa7ad6556c5035582b5b89d
+  metadata.gz: f2f053ac647f14b06d9eebb8fcacab9e36fc856c01b30e0660d5568feaff0c3b3c150d9e2e0d1760054f4de9fb3608fa6b4ff7d7ba107bdb917dffbbb45bb78c
+  data.tar.gz: e520c1667665ef6712543f1ebcd0b4fa22913393972aadbf57c609c865534cd6fa95b845a5d8ea36e6082660cc6677c5b2966f1ddfe4f9ce2a2c6a967dd289da

data/.travis.yml

@@ -2,4 +2,7 @@ language: ruby
 rvm:
   - 2.1.5
   - 2.2.1
+addons:
+  code_climate:
+    repo_token: 95f6584c5d7e081bbcde9b4de1c9564112a0f65cbdc3dff0054d571735af131f
 script: bundle exec rspec spec

data/README.md

@@ -7,6 +7,7 @@ This API let you access SNCF routes, schedules, stop points, etc.
 Note: you have to request a user token from SNCF to use this API, so this gem (https://data.sncf.com/api/register)
 
 [![Build Status](https://travis-ci.org/ook/sncf_api.svg)](https://travis-ci.org/ook/sncf_api)
+[![Code Climate](https://codeclimate.com/github/ook/sncf_api/badges/gpa.svg)](https://codeclimate.com/github/ook/sncf_api)
 
 ## Installation
 
@@ -15,7 +16,7 @@ Add this line to your application's Gemfile:
 Note: I haven't published the gem yet. For now point to this github account:
 
 ```ruby
-gem 'sncf_api', git: 'https://github.com/ook/sncf_api', branch: 'master'
+gem 'sncf_api', git: 'https://github.com/ook/sncf_api.git', branch: 'master'
 ```
 
 And then execute:

data/lib/sncf_api.rb

@@ -1,5 +1,6 @@
 require 'sncf_api/version'
 require 'sncf_api/request'
+require 'sncf_api/response'
 
 module SncfApi
   # Your code goes here...

data/lib/sncf_api/request.rb

@@ -4,7 +4,7 @@ require 'oj'
 module SncfApi
   class Request
     IMPLEMENTATION = '20150615'
-    BASE_URL = 'https://api.sncf.com/v1'
+    attr_reader :api_token
 
     class << self
       def instance(api_token: ENV['SNCF_API_TOKEN'], plan: {name: 'Free', limits: { per_day: 3_000, per_month: 90_000 }})
@@ -25,24 +25,8 @@ module SncfApi
       @countdown ||= default_countdown  
     end
 
-    KNOWN_HTTP_ERROR_CODES = [400, 401, 404, 500]
     def fetch(path)
-      response = Http.basic_auth(:user => @api_token, :pass => nil).get(BASE_URL + path)
-      body = response.body
-      decrease_quotas
-      if response.code == 200
-        content = ''
-        loop do
-          chunk = body.readpartial(HTTP::Connection::BUFFER_SIZE) rescue nil
-          break if chunk.nil?
-          content << chunk
-        end
-        content = Oj.load(content) if response.content_type.mime_type == 'application/json'
-        return content
-      end
-      if KNOWN_HTTP_ERROR_CODES.include?(response.code)
-        raise ArgumentError, "Unauthorized (#{response.code}) #{response.body}"
-      end
+      SncfApi::Response.new(path: path, request: self)
     end
 
   private

data/lib/sncf_api/response.rb

@@ -0,0 +1,77 @@
+require 'http'
+require 'oj'
+module SncfApi
+  # A reponse represent a request response from API. Note that means only ONE PAGE AT A TIME
+  # There's helper methods like #each_page and #page(index) to help you to crawl easily in the 
+  # result
+  class Response
+    BASE_URL = 'https://api.sncf.com/v1'
+
+    attr_reader :response, :request, :body, :content, :http_params
+    attr_reader :pagination, :start_page
+
+    KNOWN_HTTP_ERROR_CODES = [400, 401, 404, 500]
+    def initialize(path:, request:, http_params: nil)
+      @path = path
+      @http_params = http_params
+      @response = Http.basic_auth(:user => request.api_token, :pass => nil).get(BASE_URL + @path, params: @http_params)
+      @body = response.body
+      @request = request
+      @request.send :decrease_quotas
+
+      if @response.code == 200
+        @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
+      if KNOWN_HTTP_ERROR_CODES.include?(@response.code)
+        raise ArgumentError, "Unauthorized (#{@response.code}) #{@response.body}"
+      end
+    end
+
+    # return Hash
+    def links
+      @content['links']
+    end
+
+    def page(index=0)
+      new_http_params = @http_params.dup
+      new_http_params['start_page'] = index
+      SncfApi::Response.new(path: @path, request: @request, http_params: new_http_params)
+    end
+
+    # Execute given block from the current page until last rel=next
+    # * block param is the block that will be yield with the page content
+    # * return self
+    def each_page(&block)
+      yield @content
+      content = @content
+      loop do
+        next_page = content && content['links'] && content['links'].find { |e| e['type'] == 'next' }
+        break unless next_page
+        resp = Http.basic_auth(user: request.api_token, pass: nil).get(next_page['href'])
+        @request.send :decrease_quotas
+        break unless resp.code == 200 
+        break unless resp.content_type.mime_type == 'application/json'
+        content = ''
+        loop do
+          chunk = resp.body.readpartial(HTTP::Connection::BUFFER_SIZE) rescue nil
+          break if chunk.nil?
+          content << chunk
+        end
+        content = Oj.load(content)
+        yield content
+      end
+      self
+    end
+
+  end
+end

data/lib/sncf_api/version.rb

@@ -1,3 +1,3 @@
 module SncfApi
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/sncf_api.gemspec

@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry", "~> 0.10"
   spec.add_development_dependency "byebug", "~> 4.0"
   spec.add_development_dependency "pry-byebug", "~> 3.1"
+  spec.add_development_dependency "codeclimate-test-reporter"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sncf_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Thomas Lecavelier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-19 00:00:00.000000000 Z
+date: 2015-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 'SNCF open source API exposes plenty of services. This gem implements
   its access for ruby. API available at https://data.sncf.com/api/documentation '
 email:
@@ -158,6 +172,7 @@ files:
 - bin/setup
 - lib/sncf_api.rb
 - lib/sncf_api/request.rb
+- lib/sncf_api/response.rb
 - lib/sncf_api/version.rb
 - sncf_api.gemspec
 homepage: https://github.com/ook/sncf_api