velov 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c6bc25fdb5e560786d2f9897ae3d0b4f2797b5f
+  data.tar.gz: a21d8265d840598cc3fbc751d2a1d22991ffa32b
+SHA512:
+  metadata.gz: 0b025bbda3f01363f26e3d6c50929857c05fcedd2865a86a2fc6102cc888a27598cc67d9e1d674bb283d2aee4a5621825738f3b6d6a0ff9027a294ce8fabd6c0
+  data.tar.gz: 956418df4e0ed3e2766f77b1c1e0ec1fd37087bafc39013acfba2bb93cc211f03e5c773efacf174e86f8f8987c0ad8296202eca6291e7404bc47c1de6fc20f21

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in velov.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pierre-Baptiste Béchu
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# 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".
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'velov'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install velov
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+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`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# Default task for tests
+task default: :spec

data/lib/velov/api.rb

@@ -0,0 +1,12 @@
+module Velov
+  class API
+    # DRY API Calls
+    def self.get(params = {})
+      connection ||= Faraday.new 'https://download.data.grandlyon.com' do |conn|
+        conn.response :json, :content_type => /\bjson$/
+        conn.adapter Faraday.default_adapter
+      end
+      connection.get "/ws/smartdata/jcd_jcdecaux.jcdvelov/all.json", params
+    end
+  end
+end

data/lib/velov/station.rb

@@ -0,0 +1,40 @@
+module Velov
+  class Station
+    include Virtus.model
+
+    attribute :number, Integer
+    attribute :name, String
+    attribute :address, String
+    attribute :address_complement, String
+    attribute :city, String
+    attribute :district_number, Integer
+    attribute :lat, Float
+    attribute :lng, Float
+    attribute :bike_stands, Integer
+    attribute :status, String
+    attribute :available_bike_stands, Integer
+    attribute :available_bikes, Integer
+    attribute :last_update, DateTime
+
+    def initialize(params)
+      @number = params[Velov::NUMBER].to_i
+      @name = params[Velov::NAME]
+      @address = params[Velov::ADDRESS]
+      @address_complement = params[Velov::ADDRESS_COMPLEMENT]
+      @city = params[Velov::CITY]
+      @district_number = params[Velov::DISTRICT_NUMBER].to_i
+      @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
+      @last_update = DateTime.parse(params[Velov::LAST_UPDATE])
+    end
+
+    def self.find_by_number(number)
+      # nil if not found
+      StationList.fetch({ "field" => "number", "value" => number}).to_a.first
+    end
+  end
+end

data/lib/velov/station_list.rb

@@ -0,0 +1,36 @@
+module Velov
+  class StationList
+    include Virtus.model
+
+    attribute :size, Integer
+    attribute :list, Array[Station]
+    
+    def initialize(size)
+      @size = size
+      @list = []
+    end
+
+    def add_station(params)
+      @list << Station.new(params)
+    end
+
+    def to_a
+      @list
+    end
+
+    # Fetch data of all stations
+    def self.fetch(params = {})
+
+      response = API.get(params)
+
+      station_list = StationList.new(response.body["nb_results"])
+      
+      response.body["values"].each do |station_params|
+        station_list.add_station(station_params)
+      end
+
+      station_list
+    end
+
+  end
+end

data/lib/velov/version.rb

@@ -0,0 +1,3 @@
+module Velov
+  VERSION = "0.1.0"
+end

data/lib/velov.rb

@@ -0,0 +1,23 @@
+require 'virtus'
+require 'faraday'
+require 'faraday_middleware'
+require "velov/version"
+require "velov/api"
+require "velov/station"
+require "velov/station_list"
+module Velov
+  # Define API Constants
+  NUMBER = 0
+  NAME = 1
+  ADDRESS = 2
+  ADDRESS_COMPLEMENT = 3
+  CITY = 4
+  DISTRICT_NUMBER = 5
+  LATITUDE = 8
+  LONGITUDE = 9
+  BIKE_STANDS = 10
+  STATUS = 11
+  AVAILABLE_BIKE_STANDS = 12
+  AVAILABLE_BIKES = 13
+  LAST_UPDATE = 18
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'bundler/setup'
+require 'webmock/rspec'
+require 'vcr'
+
+require_relative '../lib/velov.rb'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/vcr_cassettes'
+  c.hook_into :webmock # or :fakeweb
+end
+

data/spec/station_list_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+describe Velov::StationList do
+  describe ":fetch" do
+    before(:each) do
+      VCR.use_cassette "fetch_valid_station_list" do
+        @station_list = Velov::StationList.fetch
+      end
+    end
+    it { expect(@station_list.size).to eq 349 }
+    it { expect(@station_list.to_a.length).to eq 349}
+  end
+end

data/spec/station_spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+
+describe Velov::Station do
+  describe ":find_by_number" do
+    context 'valid number' do
+      before(:each) do
+        VCR.use_cassette "find_valid_station_by_number" do
+          @station = Velov::Station.find_by_number(10117)
+        end
+      end
+
+      it { expect(@station.number).to eq 10117}
+      it { expect(@station.name).to eq "La Pérralière"}
+      it { expect(@station.address).to eq "171 rue Léon Blum"}
+      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.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.last_update).to eq DateTime.new(2014,8,21,14,50,31) }
+      
+    end
+
+    context 'invalid number' do
+      before(:each) do
+        VCR.use_cassette "find_invalid_station_by_number" do
+          @station = Velov::Station.find_by_number(101173456)
+        end
+      end
+
+      it { expect(@station).to be nil}
+    end
+  end
+end