bikes 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: db523843a8dffa0aa6029f3d319b76f6b96f3c12
-  data.tar.gz: bae0fc7c4b9d3c1a9caaa01891a72840fe0c83af
+SHA256:
+  metadata.gz: a7038ea6b3359ed8d9f1fd66e82d2a2cca541918e0291bec8391b4447c82e84d
+  data.tar.gz: 7bad3cd622c5b118fed44bfa1a3265891620f725b70a683afe79ae33a3fc3683
 SHA512:
-  metadata.gz: e25ce17de42d0be260d338c5066a8c318f8ef671d10f4c32c1f3894b62dec9c8bb703bd44c8c96d8dc3aafa77360cbd8a0d5a12f049d09be6f946bf29d221606
-  data.tar.gz: 1d3b24673a7df43568f4e53bbcc4ab3092c1abbbdb515324befee6f0a41d971c61a4e5d04a8adf34e6d3bd2a847d5908ffd545ed6be85be1a13bca6efa328de1
+  metadata.gz: 0b9fba647be12e42455cfe0299bf4dcc8a46e7f763878024fc1bedcb7feb65b61717b8a9c3db5c3d3de41b873d77ddd54e1b53c868a4b574d7df06f5d42e41e0
+  data.tar.gz: c5fa9a7116f8b82c9eee5bddfd5207b7202bcee5a4e2da54abb6ab25c20b9987a8fa1a3f8977ae7cae9b43227a683a5a062789c938fd6fe6a3f199d7bac33e8e

data/LICENSE.txt

@@ -1,10 +1,22 @@
-Copyright (c) 2014, Oisin Hurley
-All rights reserved.
+Copyright (c) 2014, Oisin Hurley. All rights reserved.
 
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
 
-Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+1. Redistributions of source code must retain the above copyright notice, this list
+of conditions and the following disclaimer.
 
-Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+2. Redistributions in binary form must reproduce the above copyright notice, this
+list of conditions and the following disclaimer in the documentation and/or other
+materials provided with the distribution.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -1,4 +1,4 @@
-### v0.0.1 - simple wrapper for HTTP invocations
+### v0.0.3 - simple wrapper for HTTP invocations
 
 Wraps the results from the web service at [JC Decaux](https://developer.jcdecaux.com/#/opendata/vls?page=getstarted) in `Hashie::Mash` objects for ease of access.
 
@@ -34,3 +34,16 @@ Get an array of all the 'contracts' that are deployed - each contract refers to
 ```
 b.contracts
 ```
+
+**Testing**
+
+Local testing happens using Webmock. To run the tests
+
+```
+git clone https://github.com/oisin/bikes.git
+cd bikes
+bundle install
+bundle exec rake
+```
+
+Coverage is supplied courtesy of SimpleCov, and can be found in the `coverage` directory after a successful test run.

data/lib/bikes.rb

@@ -1,5 +1,6 @@
 require 'httparty'
 require 'hashie'
+require_relative 'cache'
 
 class BikesOffline < Exception; end
 
@@ -12,18 +13,31 @@ class Bikes
   def initialize(apikey, scheme)
     @api = apikey
     @scheme = scheme
+    # Contracts refresh daily
+    @contracts_cache = Cache.new(self, :contracts_fetch)
+
+    # Full stations list refresh every 60 seconds
+    @stations_cache  = Cache.new(self, :stations_fetch, 60)
   end
 
-  def stations
-    invoke(STATIONS_URL, { contract: @scheme})
+  def station(num)
+    invoke(STATIONS_URL + '/' + num.to_s, {contract: @scheme})
   end
 
   def contracts
+    @contracts_cache.contents
+  end
+
+  def contracts_fetch
     invoke(CONTRACTS_URL)
   end
 
-  def station(num)
-    invoke(STATIONS_URL + '/' + num.to_s, {contract: @scheme})
+  def stations
+    @stations_cache.contents
+  end
+
+  def stations_fetch
+    invoke(STATIONS_URL, { contract: @scheme })
   end
 
   private

data/lib/cache.rb

@@ -0,0 +1,26 @@
+class Cache
+
+  def initialize(source, fetchm, exp=86400)
+    @expiry = exp
+    @timestamp = 0
+    @contents = []
+    @source = source
+    @fetch = fetchm
+  end
+
+  def contents
+    if expired?
+      put(@source.send(@fetch))
+    end
+    @contents
+  end
+
+  def put(stuff)
+    @timestamp = Time.now.utc.to_i
+    @contents = stuff
+  end
+  
+  def expired?
+    (Time.now.utc.to_i - @timestamp) > @expiry
+  end
+end

data/test/helpers.rb

@@ -1,4 +1,7 @@
 require 'simplecov'
+
+SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
+
 SimpleCov.start do
   add_filter '/test/'
 end

data/test/test_bikes.rb

@@ -18,25 +18,25 @@ class TestBikes < Minitest::Spec
 
     b = @bikes.contracts
 
-    b.size.must_equal 4
+    _(b.size).must_equal 4
 
-    b[1].name.must_equal 'Dublin'
-    b[1].cities[0].must_equal 'Dublin'
-    b[1].country_code.must_equal 'IE'
-    b[1].commercial_name.must_equal 'dublinbikes'
+    _(b[1].name).must_equal 'Dublin'
+    _(b[1].cities[0]).must_equal 'Dublin'
+    _(b[1].country_code).must_equal 'IE'
+    _(b[1].commercial_name).must_equal 'dublinbikes'
   end
 
   def test_stations
     stub_request(:get, STATIONS_URL).with(query: { apiKey: API_KEY, contract: 'Dublin'}).to_return({body: @stations.read})
     s = @bikes.stations
 
-    s.size.must_equal 3
-    s[2].number.must_equal 32
-    s[2].name.must_equal "PEARSE STREET"
-    s[2].address.must_equal "Pearse Street"
-    s[2].bike_stands.must_equal 30
-    s[2].available_bike_stands.must_equal 2
-    s[2].available_bikes.must_equal 27
+    _(s.size).must_equal 3
+    _(s[2].number).must_equal 32
+    _(s[2].name).must_equal "PEARSE STREET"
+    _(s[2].address).must_equal "Pearse Street"
+    _(s[2].bike_stands).must_equal 30
+    _(s[2].available_bike_stands).must_equal 2
+    _(s[2].available_bikes).must_equal 27
   end
 
   def test_station
@@ -46,8 +46,8 @@ class TestBikes < Minitest::Spec
 
     s = @bikes.station(snum)
 
-    s.wont_be_nil
-    s.number.must_equal snum
+    _(s).wont_be_nil
+    _(s.number).must_equal snum
   end
 
   def test_bad_thing_happen

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bikes
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Oisin Hurley
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-10-09 00:00:00.000000000 Z
+date: 2021-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.18'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.13.1
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.18'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.13.1
@@ -36,106 +36,140 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 2.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 2.5.1
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '4.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: 4.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '4.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: 4.1.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: '3.13'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.19.0
+        version: 3.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: '3.13'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.19.0
+        version: 3.13.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '5.14'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.3.5
+        version: 5.14.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '5.14'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.3.5
+        version: 5.14.4
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
 description: Ruby client for JCDecaux urban bike rental schemes
 email: oisin@nis.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".coveralls.yml"
-- ".gitignore"
-- ".travis.yml"
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
-- bikes.gemspec
 - lib/bikes.rb
+- lib/cache.rb
 - test/data/contracts.json
 - test/data/station32.json
 - test/data/stations.json
 - test/helpers.rb
 - test/test_bikes.rb
-homepage: http://rubygems.org/gems/bikes
+homepage: https://rubygems.org/gems/bikes
 licenses:
-- BSD
+- BSD-2-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -150,9 +184,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: JCDecaux Bikes Client
 test_files: []

data/.coveralls.yml

@@ -1 +0,0 @@
-service: travis_ci

data/.gitignore

@@ -1 +0,0 @@
-coverage

data/.travis.yml

@@ -1,5 +0,0 @@
-language: ruby
-rvm:
-  - 2.1.2
-  - 1.9.3
-  - jruby

data/Gemfile

@@ -1,8 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-gem 'simplecov', '~> 0.9', '>= 0.9.1', require: false
-gem 'coveralls', '~> 0.7', '>= 0.7.1', require: false
-gem 'rake'
-

data/Gemfile.lock

@@ -1,59 +0,0 @@
-PATH
-  remote: .
-  specs:
-    bikes (0.0.1)
-      hashie (~> 2.1, >= 2.1.2)
-      httparty (~> 0.13, >= 0.13.1)
-      json (~> 1.8, >= 1.8.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.3.6)
-    coveralls (0.7.1)
-      multi_json (~> 1.3)
-      rest-client
-      simplecov (>= 0.7)
-      term-ansicolor
-      thor
-    crack (0.4.2)
-      safe_yaml (~> 1.0.0)
-    docile (1.1.5)
-    hashie (2.1.2)
-    httparty (0.13.1)
-      json (~> 1.8)
-      multi_xml (>= 0.5.2)
-    json (1.8.1)
-    mime-types (2.4.1)
-    minitest (5.3.5)
-    multi_json (1.10.1)
-    multi_xml (0.5.5)
-    netrc (0.7.7)
-    rake (10.3.2)
-    rest-client (1.7.2)
-      mime-types (>= 1.16, < 3.0)
-      netrc (~> 0.7)
-    safe_yaml (1.0.3)
-    simplecov (0.9.1)
-      docile (~> 1.1.0)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.8.0)
-    simplecov-html (0.8.0)
-    term-ansicolor (1.3.0)
-      tins (~> 1.0)
-    thor (0.19.1)
-    tins (1.3.3)
-    webmock (1.19.0)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bikes!
-  coveralls (~> 0.7, >= 0.7.1)
-  minitest (~> 5.3, >= 5.3.5)
-  rake
-  simplecov (~> 0.9, >= 0.9.1)
-  webmock (~> 1.19, >= 1.19.0)

data/Rakefile

@@ -1,9 +0,0 @@
-task :default => :test
-
-require 'rake/testtask'
-
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList['test/*.rb']
-  t.verbose = true
-end

data/bikes.gemspec

@@ -1,19 +0,0 @@
-require 'date'
-
-Gem::Specification.new do |s|
-  s.name        = 'bikes'
-  s.version     = '0.0.2'
-  s.date        = Date.today.to_s
-  s.license     = 'BSD'
-  s.summary     = "JCDecaux Bikes Client"
-  s.description = "Ruby client for JCDecaux urban bike rental schemes"
-  s.authors     = ["Oisin Hurley"]
-  s.email       = 'oisin@nis.io'
-  s.files       = `git ls-files`.split("\n")
-  s.homepage    = 'http://rubygems.org/gems/bikes'
-  s.add_runtime_dependency 'httparty', '~> 0.13', '>= 0.13.1'
-  s.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.1'
-  s.add_runtime_dependency 'hashie', '~> 2.1', '>= 2.1.2'
-  s.add_development_dependency 'webmock', '~> 1.19', '>= 1.19.0'
-  s.add_development_dependency 'minitest', '~> 5.3', '>= 5.3.5'
-end