velov 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19060282b2c49291a65fd395377631ee08d7c4b0
-  data.tar.gz: 490e80bf8803b70335312334a0f3955ada2a8f57
+  metadata.gz: 57fb179c3645ce9deadf22d1a5ab73d100b7a2d9
+  data.tar.gz: 8e9eb1b3254f3729ee67b7c3979fd4126f473bb0
 SHA512:
-  metadata.gz: 36f8da7edcd5857fb35485d06ccb9176710516d4890c4bd029f20ee89667488456401698f16adaab54546465d6d1aad2fafbe11183798ab1d57ff436f208b8bd
-  data.tar.gz: 0548ad7fe8ab24a31dcefeee7188ddbff04f3eeea586ab3d62acfb55397985ce21cb10cdd1baac3d35b97a5ea78884afb1c862744833675e3a8996d2db729e6a
+  metadata.gz: fbd1a46125e1128e2cb5785f14339e6dcc075bc3b2060dc54910a5d31fe56c46fd0e5360d75622a091ed7654b5162e0f462c1806b5bfc85c71577a87ec14f215
+  data.tar.gz: f5bd27317ef9a7b87a082c4d8266f4189b53a1c5596290a8b6e3b6f64abac281f47f43fe9f4eeaf4f29a7ed113495c19f3f2b4e5849e5ce2f04905c8bbca341d

data/README.md

@@ -1,42 +1,107 @@
 # Velov
 
-Velov is a ruby wrapper for [Velov API](https://download.data.grandlyon.com/ws/smartdata/jcd_jcdecaux.jcdvelov.json) (Public Bike Sharing System of Lyon, France). This Wrapper allows you to play with objects like bike's stations ! It's possible to add more features in the future, like "nearest station around me".
+Velov is a ruby wrapper for [Velov API](https://download.data.grandlyon.com/ws/smartdata/jcd_jcdecaux.jcdvelov.json) (Public Bike Sharing System of Lyon, France). This Wrapper allows you to play with objects like bike's stations !
+
+[![Gem Version](https://badge.fury.io/rb/velov.svg)](http://badge.fury.io/rb/velov)
+[![Build Status](https://travis-ci.org/pbechu/velov.svg?branch=v0.1.4)](https://travis-ci.org/pbechu/velov)
+[![Coverage Status](https://img.shields.io/coveralls/pbechu/velov.svg)](https://coveralls.io/r/pbechu/velov?branch=master)
+[![Code Climate](https://codeclimate.com/github/pbechu/velov/badges/gpa.svg)](https://codeclimate.com/github/pbechu/velov)
+[![Dependency Status](https://gemnasium.com/pbechu/velov.svg)](https://gemnasium.com/pbechu/velov)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'velov'
+```ruby
+gem 'velov'
+```
 
 And then execute:
 
-    $ bundle
+```console
+bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install velov
+```console
+gem install velov
+```
 
 ## Usage
 
-### Retrieve all stations
-You can fetch data of all stations in one call:
-    
-    station_list = Velov::StationList.fetch    
+### Start with the Velov API
+
+Fetch data of all stations in one call:
+
+```ruby
+station_list = Velov::StationList.fetch
+station_list.size # => 349
+```
+
+Navigate through the data with an Array of Station:
+
+```ruby
+stations = station_list.to_a
+
+stations.each do |station|
+    puts station.name
+end
+```
+
+### Play with stations
+
+Find a specific station with its internal ID:
+
+```ruby
+station = Velov::Station.find_by_number(10117)
+station.status # => "OPEN"
+```
+
+Want more attributes ? Try one of these for a station:
+- number (internal ID)
+- name
+- address
+- address_complement
+- city
+- district_number
+- [bonus](http://www.velov.grandlyon.com/FAQ-Question-Reponse.59+M55f945504e2.0.html)
+- position (some indications to find the station)
+- lat (latitude)
+- lng (longitude)
+- bike_stands (count of bike stands at this station)
+- status ("OPEN" or "CLOSED")
+- available_bike_stands (free slots)
+- available_bikes ([ready to ride ?](http://www.annivelov.fr/))
+- availability_code (internal usage)
+- availability_label (internal usage)
+- last_update (last time data were updated)
+
+### Use the data
+
+Get reports for a list of stations:
+
+```ruby
+station_list.bike_stands # => 6832
+station_list.available_bike_stands # => 3534
+station_list.available_bikes # => 3022
+```
+
+Discover if you can reach a specific station:
 
-Use an array to navigate through the data:
-    
-    total_available_bikes = station_list.to_a.map(&:available_bikes).inject(:+)
+```ruby
+station.distance_to(45.8,4.9) # => 2.48 (km)
+```
 
-### Play with one station
-You can find a specific station with its ID:
+Find the nearest stations around you:
 
-    station = Velov::Station.find_by_number(10117)
-    station.lat
-    station.lng
+```ruby
+station_list.nearest(45.8,4.9)
+```
 
 ## Contributing
 
-1. Fork it ( http://github.com/pbechu/velov/fork )
+1. [Fork it](http://github.com/pbechu/velov/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`)

data/lib/velov.rb

@@ -6,6 +6,7 @@ require "velov/version"
 require "velov/api"
 require "velov/station"
 require "velov/station_list"
+
 module Velov
   # Define API Constants
   NUMBER = 0
@@ -14,11 +15,15 @@ module Velov
   ADDRESS_COMPLEMENT = 3
   CITY = 4
   DISTRICT_NUMBER = 5
+  BONUS = 6
+  POSITION = 7
   LATITUDE = 8
   LONGITUDE = 9
   BIKE_STANDS = 10
   STATUS = 11
   AVAILABLE_BIKE_STANDS = 12
   AVAILABLE_BIKES = 13
+  AVAILABILITY_CODE = 14
+  AVAILABILITY_LABEL = 15
   LAST_UPDATE = 18
 end

data/lib/velov/station.rb

@@ -8,12 +8,16 @@ module Velov
     attribute :address_complement, String
     attribute :city, String
     attribute :district_number, Integer
+    attribute :bonus, Boolean
+    attribute :position, String
     attribute :lat, Float
     attribute :lng, Float
     attribute :bike_stands, Integer
     attribute :status, String
     attribute :available_bike_stands, Integer
     attribute :available_bikes, Integer
+    attribute :availability_code, Integer
+    attribute :availability_label, String
     attribute :last_update, DateTime
 
     def initialize(params)
@@ -23,12 +27,16 @@ module Velov
       @address_complement = params[Velov::ADDRESS_COMPLEMENT]
       @city = params[Velov::CITY]
       @district_number = params[Velov::DISTRICT_NUMBER].to_i
+      @bonus = params[Velov::BONUS] == "Oui"
+      @position = params[Velov::POSITION]
       @lat = params[Velov::LATITUDE].to_f
       @lng = params[Velov::LONGITUDE].to_f
       @bike_stands = params[Velov::BIKE_STANDS].to_i
       @status = params[Velov::STATUS]
       @available_bike_stands = params[Velov::AVAILABLE_BIKE_STANDS].to_i
       @available_bikes = params[Velov::AVAILABLE_BIKES].to_i
+      @availability_code = params[Velov::AVAILABILITY_CODE].to_i
+      @availability_label = params[Velov::AVAILABILITY_LABEL]
       @last_update = DateTime.parse(params[Velov::LAST_UPDATE])
     end
 
@@ -38,7 +46,7 @@ module Velov
     end
 
     def distance_to(lat,lng)
-      Geocoder::Calculations.distance_between([@lat,@lng], [lat,lng])
+      Geocoder::Calculations.distance_between([@lat,@lng], [lat,lng], units: :km)
     end
   end
 end

data/lib/velov/version.rb

@@ -1,3 +1,3 @@
 module Velov
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/spec/station_spec.rb

@@ -16,12 +16,16 @@ describe Velov::Station do
       it { expect(@station.address_complement).to eq "None"}
       it { expect(@station.city).to eq "VILLEURBANNE"}
       it { expect(@station.district_number).to eq 117}
+      it { expect(@station.bonus).to eq false}
+      it { expect(@station.position).to eq "Centre de quartier, commerces"}
       it { expect(@station.lat).to eq 45.7645636665294000}
       it { expect(@station.lng).to eq 4.8923336071821100}
       it { expect(@station.bike_stands).to eq 22}
       it { expect(@station.status).to eq "OPEN"}
       it { expect(@station.available_bike_stands).to eq 12}
       it { expect(@station.available_bikes).to eq 10}
+      it { expect(@station.availability_code).to eq 1}
+      it { expect(@station.availability_label).to eq "Vert"}
       it { expect(@station.last_update).to eq DateTime.new(2014,8,21,14,50,31) }
       
     end
@@ -44,6 +48,6 @@ describe Velov::Station do
       end
     end
 
-    it { expect(@station.distance_to(45.8,4.9)).to eq 2.4761240501617032 }
+    it { expect(@station.distance_to(45.8,4.9)).to eq 3.9849353849054903 }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: velov
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Pierre-Baptiste Béchu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-21 00:00:00.000000000 Z
+date: 2014-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler