caruby2go 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9d8f3553cff2a26e8158534f0c9b8f0dfec95b1
-  data.tar.gz: cdadd90cbddbf5dc632f6048dd4dac845e75e2bf
+  metadata.gz: ad0725cbc7907bfcb303396fb89ce0d9f93de48f
+  data.tar.gz: bceac7b4db47cc3051e3c01a1a3e583bd9f81380
 SHA512:
-  metadata.gz: 29b118da409b2f32432672762889d293948e4be92a4d2a4b2d73cb54f372975720bc917ec06b95a2feccd0a31ad7076f44bc9afd5db30be28daebd291b1b7cc1
-  data.tar.gz: ddc779599342762cb7e78c6405de4e1e233e74934ecda9d148b9bfffe5638435cec179974827bca2540b27b1460de10f7f9c53faa6a6ce55f580a1f176b359ae
+  metadata.gz: 45ab691d369f0a373a53e04b56872b0c9b677a133400d76c3e304294ac176e7a8bece40f10473801dca61674881323258a1af63f310a4b88ea04dfd0db811100
+  data.tar.gz: eaa3dba26f5add897b677cc2f002ec56bf217974b29a68abd0c43264a3e2e13b76f17fad8acd5a9c49796c9db2cabd44b966b3fa8e53cb5448700386a261adaa

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    caruby2go (0.0.4)
+    caruby2go (0.1.0)
       thor (~> 0.19.1)
 
 GEM

data/README.md

@@ -28,21 +28,39 @@ Or install it yourself as:
 
 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
+## Publishing
 
-    $ set CONSUMER_KEY=<your_consumer_key>
-    $ bin/caruby2go p kobenhavn
-or 
+    $ gem push pkg/caruby2go-<version>.gem
+
+## Usage
+caruby2go requires you to have a car2go consumer key
+
+### In your project
+
+    caruby2go_client = Caruby2go.new(ENV['CAR2GO_CONSUMER_KEY'], 'twincities')
+    caruby2go_client.vehicles
+
+By default [the Car2Go API URL](https://www.car2go.com/api/v2.1) is used, but you have the option to pass in an alternate URL.
+I added this option so I could use Runscape to monitor API calls.
+
+     caruby2go_client = Caruby2go.new(ENV['CAR2GO_CONSUMER_KEY'], 'twincities', 'https://www-car2go-com-eeeeeeee.runscope.net/api/v2.1')
+
+### Included script
+#### Find car locations for a city
 
     $ 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.
+#### Finding a city name
+Use the `locationName` value (spaces removed) from the following call
+
+    $ CONSUMER_KEY=<your_consumer_key> bin/caruby2go l
+
+[Freerider](https://github.com/eebbesen/freerider) has a script that will return an alphabetized, formatted list of all valid locations, too.
+
+## Reference implementations
+* bin/caruby2go in this project
 
-## 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.
+* [Freerider](https://github.com/eebbesen/freerider) is a gem which uses caruby2go to access car2go's API to track Car2Go vehicle movement.
 
 ## Contributing
 

data/lib/caruby2go.rb

@@ -8,9 +8,10 @@ require 'json'
 class Caruby2go
   CAR2GO_URI = 'https://www.car2go.com/api/v2.1'
 
-  def initialize(consumer_key, location = nil)
+  def initialize(consumer_key, location=nil, uri=CAR2GO_URI)
     @consumer_key = consumer_key
     @location = location
+    @uri = uri
   end
 
   def gasstations # placemarks
@@ -33,7 +34,7 @@ class Caruby2go
 
   def build_uri(endpoint)
     loc_part = @location ? "&loc=#{@location}" : nil
-    "#{CAR2GO_URI}/#{endpoint}?oauth_consumer_key=#{@consumer_key}#{loc_part}&format=json"
+    "#{@uri}/#{endpoint}?oauth_consumer_key=#{@consumer_key}#{loc_part}&format=json"
   end
 
   def issue_get(uri, json_header = 'placemarks')
@@ -43,4 +44,8 @@ class Caruby2go
     raise InvalidLocationError.new(@location) if '400 Bad Request' == e.message
     raise e
   end
+
+  def uri
+    @uri
+  end
 end

data/lib/caruby2go/version.rb

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

data/test/test_caruby2go.rb

@@ -5,7 +5,7 @@ require 'byebug'
 
 class TestCaruby2go < Minitest::Test
   def setup
-    @caruby2go = Caruby2go.new('testkey', 'MPLS')
+    @caruby2go = Caruby2go.new('testkey', 'MPLS', 'https://www.justabaseuri.com2go')
   end
 
   def test_initialize
@@ -13,13 +13,13 @@ class TestCaruby2go < Minitest::Test
   end
 
   def test_build_uri_with_location
-    assert_equal 'https://www.car2go.com/api/v2.1/endpt?oauth_consumer_key=testkey&loc=MPLS&format=json',
+    assert_equal "#{@caruby2go.send(:uri)}/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 "#{@caruby2go.send(:uri)}/endpt?oauth_consumer_key=testkey&format=json",
                  @caruby2go.send(:build_uri, 'endpt')
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: caruby2go
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Eric Ebbesen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-21 00:00:00.000000000 Z
+date: 2016-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor