caruby2go 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f22e4a39a7a340b3fb16a7be32939d306baf9f4
-  data.tar.gz: d2616acb3a170086305def7043567e4c3d8f6442
+  metadata.gz: e9d8f3553cff2a26e8158534f0c9b8f0dfec95b1
+  data.tar.gz: cdadd90cbddbf5dc632f6048dd4dac845e75e2bf
 SHA512:
-  metadata.gz: e3bd82e81b475345e68d61bd077deaa41875f61ec0549a2a0c21ae2b451094fd80ca3323416656a2a04c6a1dcbdd69baa57c63affd7ce0f64850f21d02487d00
-  data.tar.gz: be82b50161024ef86b90155ad611062fe790b0957dd185cb8c935202ddc9ec801d7bfa162b2c703688e3d9af0cf5fe9bdf38f8f153ad115111b46252dc6c80f3
+  metadata.gz: 29b118da409b2f32432672762889d293948e4be92a4d2a4b2d73cb54f372975720bc917ec06b95a2feccd0a31ad7076f44bc9afd5db30be28daebd291b1b7cc1
+  data.tar.gz: ddc779599342762cb7e78c6405de4e1e233e74934ecda9d148b9bfffe5638435cec179974827bca2540b27b1460de10f7f9c53faa6a6ce55f580a1f176b359ae

data/Gemfile.lock

@@ -1,11 +1,13 @@
 PATH
   remote: .
   specs:
-    caruby2go (0.0.1)
+    caruby2go (0.0.4)
+      thor (~> 0.19.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    byebug (6.0.2)
     celluloid (0.16.0)
       timers (~> 4.0.0)
     coderay (1.1.0)
@@ -33,6 +35,7 @@ GEM
       rb-inotify (>= 0.9)
     lumberjack (1.0.9)
     method_source (0.8.2)
+    minitest (5.4.3)
     nenv (0.2.0)
     notiffany (0.0.6)
       nenv (~> 0.1)
@@ -62,14 +65,10 @@ GEM
     rspec-mocks (3.2.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.2.0)
-    rspec-nc (0.2.0)
-      rspec (>= 2.9)
-      terminal-notifier (>= 1.4)
     rspec-support (3.2.2)
     shellany (0.0.1)
     slop (3.6.0)
     spy (0.4.1)
-    terminal-notifier (1.6.2)
     thor (0.19.1)
     timers (4.0.1)
       hitimes
@@ -79,14 +78,17 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.7)
+  byebug
   caruby2go!
-  guard
-  guard-rspec
-  pry
-  pry-nav
-  pry-remote
+  guard (~> 2.12)
+  guard-rspec (~> 4.5)
+  minitest
+  pry (~> 0.10)
+  pry-nav (~> 0.2)
+  pry-remote (~> 0.1)
   rake (~> 10.0)
-  rspec
-  rspec-nc
-  spy
-  thor
+  rspec (~> 3.2)
+  spy (~> 0.4)
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -1,3 +1,5 @@
+[![Circle CI](https://circleci.com/gh/eebbesen/caruby2go.svg?style=shield)](https://circleci.com/gh/eebbesen/caruby2go)
+
 # caruby2go
 
 caruby2go is a gem that exposes [the car2go api](https://code.google.com/p/car2go/wiki/index_v2_1).
@@ -24,16 +26,23 @@ Or install it yourself as:
 
     $ rake build
 
-build (in this project's root) will build and install the gem locally.
+Executing `build` (in this project's root) will build and install the gem locally.
 
 ## Local usage
-The script requires you to set the CONSUMER_KEY environment variable to your car2Go consumer key
+The script requires you to set the `CONSUMER_KEY` environment variable to your car2go consumer key
 
     $ set CONSUMER_KEY=<your_consumer_key>
     $ bin/caruby2go p kobenhavn
 or 
 
     $ CONSUMER_KEY=<your_consumer_key> bin/caruby2go p kobenhavn
+or set it for the application user via a profile file.
+
+## Finding a city name
+You will see `400 Bad Request (OpenURI::HTTPError)` if you enter an invalid city.  I was unable to locate a list of valid cities (the car2go locations endpoint does not provied that information) but have compiled a list of my own which you can view at doc/cities.txt.
+
+## Reference implementation
+[Freerider](https://github.com/eebbesen/freerider) is a gem which uses caruby2go to access car2go's API to identify cars you can refuel for free minutes.
 
 ## Contributing
 

data/bin/caruby2go

@@ -2,12 +2,14 @@
 
 require 'thor'
 require_relative '../lib/caruby2go.rb'
-require 'pry'
 
 ##
 # Script for running the gem from the command line
 class Caruby2goScript < Thor
   RECORD_SEPARATOR = '========================================================='
+
+  class_option :raw, :type => :boolean, :desc => "Print the raw JSON from Car2Go"
+
   desc 'vehicles CITY', 'get vehicles for CITY'
   def vehicles(city)
     call_api(city)
@@ -35,7 +37,7 @@ class Caruby2goScript < Thor
     return if ENV['CONSUMER_KEY']
     puts 'Set environment variable CONSUMER_KEY to your Car2Go consumer key.'
     puts 'For example:'
-    puts '    $ CONSUMER_KEY=mykey bin/caruby2go v twincities'
+    puts '    $ CONSUMER_KEY=yourkey bin/caruby2go v twincities'
     false
   end
 
@@ -43,17 +45,21 @@ class Caruby2goScript < Thor
     require_key
     caruby2go = Caruby2go.new(ENV['CONSUMER_KEY'], city)
     results = caruby2go.send("#{caller_locations(1, 1)[0].label}".to_sym)
-    pretty_print results
+    print results
   end
 
-  def pretty_print(records)
-    records.each do |record|
-      puts RECORD_SEPARATOR
-      record.each do |k, v|
-        puts "#{k}:: #{v}"
+  def print(records)
+    if options[:raw]
+      puts records
+    else
+      records.each do |record|
+        puts RECORD_SEPARATOR
+        record.each do |k, v|
+          puts "#{k}:: #{v}"
+        end
       end
+      puts RECORD_SEPARATOR
     end
-    puts RECORD_SEPARATOR
   end
 end
 

data/caruby2go.gemspec

@@ -18,18 +18,21 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.0'
+
   spec.add_dependency 'thor', '~> 0.19.1'
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
 
   # test
+  spec.add_development_dependency 'minitest'
   spec.add_development_dependency 'rspec', '~> 3.2'
-  spec.add_development_dependency 'rspec-nc', '~> 3.2'
   spec.add_development_dependency 'guard', '~> 2.12'
   spec.add_development_dependency 'guard-rspec', '~> 4.5'
   spec.add_development_dependency 'pry', '~>0.10'
   spec.add_development_dependency 'pry-remote', '~> 0.1'
   spec.add_development_dependency 'pry-nav', '~> 0.2'
   spec.add_development_dependency 'spy', '~> 0.4'
+  spec.add_development_dependency 'byebug'
 end

data/circle.yml

@@ -0,0 +1,4 @@
+machine:
+  ruby:
+    version:
+      2.2.0

data/lib/caruby2go.rb

@@ -1,9 +1,10 @@
 require 'caruby2go/version'
+require 'invalid_location_error'
 require 'open-uri'
 require 'json'
 
 ##
-# Wraps the Car2Go public API endpoints
+# Wraps the Car2Go public API
 class Caruby2go
   CAR2GO_URI = 'https://www.car2go.com/api/v2.1'
 
@@ -31,12 +32,15 @@ class Caruby2go
   private
 
   def build_uri(endpoint)
-    loc_part = @location ? "loc=#{@location}" : nil
-    "#{CAR2GO_URI}/#{endpoint}?#{loc_part}&oauth_consumer_key=#{@consumer_key}&format=json"
+    loc_part = @location ? "&loc=#{@location}" : nil
+    "#{CAR2GO_URI}/#{endpoint}?oauth_consumer_key=#{@consumer_key}#{loc_part}&format=json"
   end
 
   def issue_get(uri, json_header = 'placemarks')
     data = open(uri).read
     JSON.parse(data)[json_header]
+  rescue OpenURI::HTTPError => e
+    raise InvalidLocationError.new(@location) if '400 Bad Request' == e.message
+    raise e
   end
 end

data/lib/caruby2go/version.rb

@@ -1,3 +1,3 @@
 class Caruby2go
-  VERSION = '0.0.2'
+  VERSION = '0.0.4'
 end

data/lib/invalid_location_error.rb

@@ -0,0 +1,5 @@
+class InvalidLocationError < StandardError
+  def initialize(location)
+    super "Car2Go probably doesn't like the city you entered: #{location}"
+  end
+end

data/test/test_caruby2go.rb

@@ -1,6 +1,7 @@
 require 'minitest/autorun'
 require './lib/caruby2go'
 require 'spy/integration'
+require 'byebug'
 
 class TestCaruby2go < Minitest::Test
   def setup
@@ -12,13 +13,13 @@ class TestCaruby2go < Minitest::Test
   end
 
   def test_build_uri_with_location
-    assert_equal 'https://www.car2go.com/api/v2.1/endpt?loc=MPLS&oauth_consumer_key=testkey&format=json',
+    assert_equal 'https://www.car2go.com/api/v2.1/endpt?oauth_consumer_key=testkey&loc=MPLS&format=json',
                  @caruby2go.send(:build_uri, 'endpt')
   end
 
   def test_build_uri_without_location
     @caruby2go = Caruby2go.new('testkey')
-    assert_equal 'https://www.car2go.com/api/v2.1/endpt?&oauth_consumer_key=testkey&format=json',
+    assert_equal 'https://www.car2go.com/api/v2.1/endpt?oauth_consumer_key=testkey&format=json',
                  @caruby2go.send(:build_uri, 'endpt')
   end
 
@@ -70,6 +71,36 @@ class TestCaruby2go < Minitest::Test
     run_mock(gasstations_json, :gasstations)
   end
 
+  def test_issue_get_400
+    mock_open_uri = Minitest::Mock.new
+    mock_open_uri.expect(:read, nil) do
+      raise OpenURI::HTTPError.new('400 Bad Request', nil)
+    end
+
+    error = assert_raises InvalidLocationError do
+      OpenURI.stub :open_uri, mock_open_uri do
+        @caruby2go.send(:issue_get, 'http://example.com')
+      end
+    end
+    assert_equal "Car2Go probably doesn't like the city you entered: MPLS", error.message
+  end
+
+  def test_issue_get_other_than_400
+    mock_open_uri = Minitest::Mock.new
+    mock_open_uri.expect(:read, nil) do
+      raise OpenURI::HTTPError.new('401 Unauthorized', nil)
+    end
+
+    error = assert_raises OpenURI::HTTPError do
+      OpenURI.stub :open_uri, mock_open_uri do
+        @caruby2go.send(:issue_get, 'http://example.com')
+      end
+    end
+    assert_equal '401 Unauthorized', error.message
+  end
+
+  private
+
   def run_mock(json, method)
     mock_open_uri = Minitest::Mock.new
     mock_open_uri.expect(:read, json)

data/test/test_invalid_location_error.rb

@@ -0,0 +1,9 @@
+require 'minitest/autorun'
+require './lib/invalid_location_error'
+
+class TestInvalidLocationError < Minitest::Test
+  def test_initialize
+    ile = InvalidLocationError.new('nowheresville')
+    assert_equal "Car2Go probably doesn't like the city you entered: nowheresville", ile.message
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: caruby2go
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Eric Ebbesen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-24 00:00:00.000000000 Z
+date: 2015-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -53,21 +53,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-nc
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -164,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: Ruby gem that wraps the car2go API -- only supports the public API at
   present
 email:
@@ -183,10 +197,13 @@ files:
 - bin/caruby2go
 - build
 - caruby2go.gemspec
+- circle.yml
 - lib/caruby2go.rb
 - lib/caruby2go/version.rb
+- lib/invalid_location_error.rb
 - test/test_caruby2go.rb
 - test/test_caruby2go_integration.rb
+- test/test_invalid_location_error.rb
 homepage: https://github.com/eebbesen/caruby2go
 licenses:
 - MIT
@@ -199,7 +216,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -207,10 +224,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Ruby gem that wraps the car2go API
 test_files:
 - test/test_caruby2go.rb
 - test/test_caruby2go_integration.rb
+- test/test_invalid_location_error.rb