velibe 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77f7f5b9baaec5d5a804ff15b0a344df335be84b
-  data.tar.gz: d2bfd4d5d77d941a68033ee17cf63b98faac404d
+  metadata.gz: ae617e07c50693971153c7825691b81e1816898d
+  data.tar.gz: 2de7a804bd6db847fd50026885ddac4cd9a4d53e
 SHA512:
-  metadata.gz: a721e24aa50e2928b6fc60296142fa6c79d2aeaf653760f116d8307f1ecd3672c7ed1a8555bb90d32bbd84910e3968191eea59587e56507350ca94097e388075
-  data.tar.gz: 0781a73c8ae7f37ce033996c5bcdeaf1e4226feba15bb8c8bc99eeb90119d9af5ddb2e0199f4c92f9a36ad428caa47bc7c03765590ebfdc77d0aa424d1afdc14
+  metadata.gz: cd72fc4d01a67a5578fadc1e9644c56cbde7c048aa1a7033e415d524822b93eae7500bc423d49b0b7095712ad6e870e377417e28326bcb4628f253632364b604
+  data.tar.gz: 1f384f4d42df814426149a781d5b59b22c6c554f9f7f0b37d155ca16814fbc833107f6c92c14f17606306101e7d4bbf1bf88fdae4505244f8f522d9a39e26107

data/.rspec

@@ -1,2 +1,3 @@
 --format documentation
 --color
+--require spec_helper

data/CHANGELOG.md

@@ -5,11 +5,18 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
 
+## [0.2.1] - 2015-11-30
+### Added
+- documentation about new commands and config
+### Fixed
+- access to token in config file
+- display of wrong station number
+
 ## [0.2.0] - 2015-11-29
 ### Added
 - favorites storage with a `.velibe.yaml`
 - commands to *display*, *add* and *reset* favorites
-- CI setup (see badge on README)
+- CI setup (see badge on README): unit test, coverage, travis and coveralls
 
 ## [0.1.0] - 2015-11-18
 ### Changed
@@ -17,7 +24,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [0.0.2] - 2015-11-11
 ### Added
-- Data and draft of sqlite dtabse for storing stations and some stats
+- Data and draft of sqlite database for storing stations and some stats
 ### Fixed
 - naming convention
 ### Changed
@@ -27,7 +34,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ## [0.0.1] - 2015-07-04
 - Initial Release
 
-[unreleased]: https://github.com/AdrieanKhisbe/velibe/compare/v0.2.0...HEAD
+[unreleased]: https://github.com/AdrieanKhisbe/velibe/compare/v0.2.1...HEAD
+[0.2.1]: https://github.com/AdrieanKhisbe/velibe/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/AdrieanKhisbe/velibe/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/AdrieanKhisbe/velibe/compare/v0.0.2...v0.1.0
 [0.0.2]: https://github.com/AdrieanKhisbe/velibe/compare/v0.0.1...v0.0.2

data/README.md

@@ -7,6 +7,7 @@ VeLibe
 [![Build Status](https://travis-ci.org/AdrieanKhisbe/velibe.svg)](https://travis-ci.org/AdrieanKhisbe/velibe)
 [![Coverage Status](https://coveralls.io/repos/AdrieanKhisbe/velibe/badge.svg?branch=master&service=github)](https://coveralls.io/github/AdrieanKhisbe/velibe?branch=master)
 [![Code Climate](https://codeclimate.com/github/AdrieanKhisbe/velibe/badges/gpa.svg)](https://codeclimate.com/github/AdrieanKhisbe/velibe)
+[![Dependency Status](https://gemnasium.com/AdrieanKhisbe/velibe.svg)](https://gemnasium.com/AdrieanKhisbe/velibe)
 
 CLI tool included to help you see if there is bikes around.
 
@@ -17,7 +18,7 @@ address, and some stat collection is planed and might be implemented soon.
 
 Just install the gem, and you'll have access to this wonderful tool :D
      
-    $ gem install Velibe
+    $ gem install velibe
 
 The cli relies on the JcDecaux API. You need an api token to be able to use it.
 You can see the official site to get one [there]
@@ -25,14 +26,36 @@ You can see the official site to get one [there]
 You'll need to create an [account](https://developer.jcdecaux.com/#/account),
 and an acces token will be then granted
 
-This token is to be stored in the `VELIBE_TOKEN` variable environment.
+This token is to be stored in the `VELIBE_TOKEN` variable environment, or in the yaml config
+file under the `token` key.
 
 ## Usage
 
 Basic usage of the commandline is to query the API to see
 the status of some specific station:
 
-     $ velibe 10042 18012
+     $ velibe 10042 18012 13020
+       Velibe >> Stations 10042, 18012, 13020:
+               > Station 10042 - poissonnière - enghien:  15 Velo(s) libre(s) pour 17 places libres
+               > Station 18012 - doudeauville stephenson:  1 Velo(s) libre(s) pour 33 places libres
+               > Station 13020 - mendes france:  25 Velo(s) libre(s) pour 17 places libres
 
- 
+Velibe handle storing of favorites stations, those would be the one
+that will be querried when no argument is provided.
 
+You can control favorites with the `favorite` subcommand (which can be shorten
+to `fav` or `f`.
+This accept different subcommands:
+
+- `a`/`add <sta1> <sta2>` : add stations to favorites
+- `reset`/`setup [--force|-f]` : setup the config version, or reset it.
+  you will need to add the *force flag* to erase existing config
+- if none is provided, just output current favorites.
+
+Configuration is stored in `~/.velib.yaml` which you can also edit by hand
+ and eventually version in you *dotfiles* repo.
+
+    $ cat ~/.velib.yaml
+    ---
+    favorites: [10035, 19003, 19004, 10031]
+    token: <this-is-your-token-string>

data/bin/velibe

@@ -5,15 +5,16 @@
 require 'velibe'
 
 case ARGV[0]
-  when /f(av(orite)?)?$/
-    # handle favorites
+  when /f(av(orite)?)?$/  # handle favorites
+    stations = ARGV[2..-1] || []
+    force = ARGV[2..-1].any? { |s| /-(f|-force)/ }
+
     case ARGV[1]
       when /a(dd)?/
-        stations = ARGV[2..-1]
-        # TODO: check if all number
+        stations, wrong_arg = stations.partition { |n| n =~ /\d+/ }
+        puts "BEWARE: '#{wrong_arg.join(', ')}' are not stations number and where ignored" unless wrong_arg.empty?
         Velibe.add_favorite(stations)
       when /setup|reset/
-        force = ARGV[2..-1].any? { |s| /-(f|-force)/ }
         if Velibe.reset_favorites(force)
           puts 'Favorites Stations were reset'
         else
@@ -23,7 +24,13 @@ case ARGV[0]
         Velibe.print_favorites
     end
 
-  else
-    # TODO: check if all number
-    Velibe.print_stations(ARGV)
+  when /setup/ # setup database
+    force = ARGV[1] =~ /-(f|-force)/
+    Velibe.setup_station_database(force)
+    Velibe.reset_favorites(force)
+
+  else # just Query stations
+    stations, wrong_arg = ARGV.partition { |n| n =~ /\d+/ }  # LATER: check station really exist
+    puts "BEWARE: '#{wrong_arg.join(', ')}' are not stations number and were ignored" unless wrong_arg.empty?
+    Velibe.print_stations(stations)
 end

data/lib/velibe.rb

@@ -43,13 +43,18 @@ module Velibe
     end
   end
 
+  # FIXME: text display from there
   def self.reset_favorites(force = false)
     KvStore.reset_favorite_stations if force or KvStore.favorite_stations.empty?
+    # FIXME: ensure backup!! [store in history array]
   end
 
   def self.add_favorite(stations)
     KvStore.add_favorite_station(*stations)
   end
 
+  def self.setup_station_database(force = false)
+    Database.create if not Database.exist? or force
+  end
 
 end

data/lib/velibe/api_velib.rb

@@ -1,11 +1,12 @@
 # -*- coding: utf-8 -*-
 require 'http'
 require 'json'
+require 'velibe/db/kv_store' # TODO: refactor injection?
 
 module Velibe
   class ApiVelib
 
-    API_KEY = ENV['VELIBE_TOKEN'] || KvStore.token || raise('No token provided')
+    API_KEY = ENV['VELIBE_TOKEN'] || Velibe::KvStore.token || raise('No token provided')
 
     API_HOST = 'https://api.jcdecaux.com'
     API_PARAM = { contract: 'paris', apiKey: API_KEY }

data/lib/velibe/db/database.rb

@@ -5,22 +5,23 @@ require 'pathname'
 require 'sqlite3'
 require 'active_record'
 require 'csv'
+require 'velibe/db/models'
 
 module Velibe
 
   module Database
-    NAME = '~/.velib.db' # TODO: more generic
-    PATH = Pathname.new(NAME).expand_path # .to_s?
-    DATA_CSV  = '../../data/Paris.csv'
+    DB_NAME = '~/.velib.db' # TODO: more generic + config
+    DB_PATH = Pathname.new(DB_NAME).expand_path # .to_s?
+    DATA_CSV = '../../../data/Paris.csv'
+    DATA_CSV_FILE = File.join(File.dirname(File.expand_path(__FILE__)), DATA_CSV)
     #  §see: http://stackoverflow.com/questions/7828066/accessing-files-packaged-into-a-ruby-gem
 
     def self.exist?
-      PATH.exist? # §check
+      DB_PATH.exist? # §check
     end
 
     def self.active_connect
-      ActiveRecord::Base.establish_connection(adapter: 'sqlite3',
-                                              database: PATH.to_s)
+      ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: DB_PATH.to_s
     end
 
     def self.create
@@ -35,15 +36,13 @@ module Velibe
     end
 
     def self.connexion
-      return SQlite3::Database.new(PATH.to_s)
+      return SQlite3::Database.new(DB_PATH.to_s)
       # §see:options
       # §maybe: delete?  [not that working?]
     end
-    # §todo: version block?
 
     def self.prune
-      #§later: check no connected?
-      FileUtils.rm(PATH) if exist?
+      FileUtils.rm(DB_PATH) if self.exist?
     end
 
     #
@@ -52,41 +51,38 @@ module Velibe
 
         create_table :stations do |t|
           t.integer :number
-          t.string  :name
-          t.string  :address
-          t.float   :latitude
-          t.float   :longitude
-          t.index   :number # ¤note: must be declared before
+          t.string :name
+          t.string :address
+          t.float :latitude
+          t.float :longitude
+          t.index :number # ¤note: must be declared before
         end
 
         create_table :statuses do |t|
           t.integer :station_id
           t.boolean :status
-          t.integer  :bike_stands
-          t.integer  :available_bikes
-          t.integer  :available_bike_stands
+          t.integer :bike_stands
+          t.integer :available_bikes
+          t.integer :available_bike_stands
           t.timestamp :last_update
-          # t.timestamps
         end
 
-        #§todo: create others
+        # §todo: create others
 
       end
     end
 
     def self.populate
       # MAYBE: Use fast cv
-      csv_file =  File.join(File.dirname(File.expand_path(__FILE__)), DATA_CSV) # TODO: extract
-      # ¤see: stopwatch  > ???
+      # ¤see: stopwatch  > to bench creation. >> (but overkill since just one step operation)
       puts 'Populate Database from csv Station description'
       # ¤note: transaction for faster insert
       ActiveRecord::Base.transaction do
-        CSV.foreach(csv_file, headers: true, converters: :numeric) do |row|
+        CSV.foreach(DATA_CSV_FILE, headers: true, converters: :numeric) do |row|
           # §TODO: converter
           #  header_converters: :underscore -> tried but get: NoMethodError: undefined method `arity' for nil:NilClass
-          Models::Station.create(number: row['Number'], name: row['Name'], address: row['Address'],
-                                 latitude: row['Latitude'], longitude: row['Longitude'])
-          # ¤note: inspect send back a hash
+          Station.create(number: row['Number'], name: row['Name'], address: row['Address'],
+                         latitude: row['Latitude'], longitude: row['Longitude'])
         end
       end
     end

data/lib/velibe/station_status.rb

@@ -1,61 +1,61 @@
 # -*- coding: utf-8 -*-
 
-# §todo: new Station will go in module
-# Todo: put in sub file?
-
-class StationStatus
-  attr_reader  :name, :available_bikes, :available_bike_stands
-
-  def initialize (name, available_bikes, available_bike_stands)
-    # Maybe: enhance with bike_stand, and last_update
-    @name= name
-    @available_bikes = available_bikes
-    @available_bike_stands= available_bike_stands
-    # TODO: creation Timestamp
-  end
-
-  def to_s
-    "Station #{@name}:  #{@available_bikes} Velo(s) libre(s) pour #{@available_bike_stands} places libres"
-  end
-
-  def to_csv(sep = ';')
-    [@name, @available_bikes, @available_bike_stands].join(sep)
-  end
-
-  # FIXME: replace comment with doc
-  # TODO: maybe extract in Trajet: + method: velo dispo, stand dispo
-  def can_leave?
-    @available_bikes > 0 and not @available_bikes.nil? # test si nil quand pas de velo
-  end
-  # MAYBE REPLACE VALUE: 0 no, 1 un peu, 2 attention
-  def can_go?
-    @available_bike_stands > 0 and not @available_bike_stands # test si nil quand pas de velo
-  end
-
-  def can_go_to?(station)
-    self.can_leave? and station.can_go?
-  end
-
-  #  TODO rename
-  def self.string_from_hash(json)
-    StationStatus.from_hash(json).to_s
-  end
-
-  def self.from_hash(json)
-    # TODO: sanity check of jzon
-    name = json[:name].capitalize #RAISE EROR if neede
-    available_bikes = json[:available_bikes]
-    available_bike_stands = json[:available_bike_stands]
-    # T
-    self.new(name, available_bikes, available_bike_stands)
-  end
+module Velibe
+  class StationStatus
+    attr_reader :name, :available_bikes, :available_bike_stands
+
+    def initialize (name, available_bikes, available_bike_stands)
+      # Maybe: enhance with bike_stand, and last_update
+      @name= name
+      @available_bikes = available_bikes
+      @available_bike_stands= available_bike_stands
+      # TODO: creation Timestamp
+    end
+
+    def to_s
+      "Station #{@name}:  #{@available_bikes} Velo(s) libre(s) pour #{@available_bike_stands} places libres"
+    end
+
+    def to_csv(sep = ';')
+      [@name, @available_bikes, @available_bike_stands].join(sep)
+    end
+
+    # FIXME: replace comment with doc
+    # TODO: maybe extract in Trajet: + method: velo dispo, stand dispo
+    def can_leave?
+      @available_bikes > 0 and not @available_bikes.nil? # test si nil quand pas de velo
+    end
+
+    # MAYBE REPLACE VALUE: 0 no, 1 un peu, 2 attention
+    def can_go?
+      @available_bike_stands > 0 and not @available_bike_stands # test si nil quand pas de velo
+    end
+
+    def can_go_to?(station)
+      self.can_leave? and station.can_go?
+    end
+
+    def self.string_from_json(json)
+      StationStatus.from_hash(json).to_s
+    end
+
+    def self.from_hash(json)
+      # TODO: sanity check of jzon
+      name = json[:name].capitalize #RAISE EROR if neede
+      available_bikes = json[:available_bikes]
+      available_bike_stands = json[:available_bike_stands]
+      # T
+      self.new(name, available_bikes, available_bike_stands)
+    end
+
+    # MAYBE Might belong in formater?
+    def self.print_from_json(json_string, prefix='')
+      data = JSON.parse(json_string, symbolize_names: true)
+      status = StationStatus.from_hash(data)
+      puts "#{prefix}#{status}"
+      status
+    end
 
-  # MAYBE Might belong in formater?
-  def self.print_from_json(json_string, prefix='')
-    data = JSON.parse(json_string, symbolize_names: true)
-    status = StationStatus.from_hash(data)
-    puts "#{prefix}#{status}"
-    status
   end
 
 end

data/lib/velibe/version.rb

@@ -1,3 +1,3 @@
 module Velibe
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/spec/spec_helper.rb

@@ -1,19 +1,21 @@
+velibe_lib = File.expand_path('../../lib', __FILE__)
 
-if ENV["TRAVIS"]
-  require "simplecov"
-  require "coveralls"
+if ENV['TRAVIS']
+  require 'simplecov'
+  require 'coveralls'
 
   SimpleCov.formatter = Coveralls::SimpleCov::Formatter
   SimpleCov.start do
     # No need to report coverage metrics for the test code
-    add_filter "test"
+    add_filter 'test'
   end
 
   # Eager load the entire lib directory so that SimpleCov is able to report
   # accurate code coverage metrics.
-  velibe_lib = File.expand_path("../../lib", __FILE__)
   at_exit { Dir["#{velibe_lib}/**/*.rb"].each { |rb| require(rb) } }
+else
+
+  $LOAD_PATH.unshift velibe_lib
+  require 'velibe'
 end
 
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require 'velibe'

data/spec/station_status_spec.rb

@@ -1,13 +1,13 @@
 require 'spec_helper'
 
 
-describe StationStatus do
+describe Velibe::StationStatus do
 
   describe '#new' do
 
     context 'Can create Status with proper values' do
 
-      let(:status) { StationStatus.new 'AB', available_bikes= 2, available_bike_stands=4 }
+      let(:status) { Velibe::StationStatus.new 'AB', available_bikes= 2, available_bike_stands=4 }
 
       it 'has proper name' do
         expect(status.name).to eq 'AB'
@@ -26,7 +26,7 @@ describe StationStatus do
 
      context 'handle valid input values' do
         let(:data) { { name: 'station', available_bikes: 2, available_bike_stands:4 } }
-        let(:status) { StationStatus.from_hash(data) }
+        let(:status) { Velibe::StationStatus.from_hash(data) }
         it 'capitalize station name' do expect(status.name).to eq 'Station' end
         it { expect(status.available_bikes).to eq 2 }
 

data/velibe.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'http', '~> 0.9.8'
-  spec.add_dependency 'sqlite3'
-  spec.add_dependency 'activerecord'
+  spec.add_dependency 'sqlite3', '~> 1.3'
+  spec.add_dependency 'activerecord', '~> 4'
   spec.add_dependency 'moneta', '~> 0.8'
 
   spec.add_development_dependency 'bundler', '~> 1.6'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: velibe
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Adriean Khisbe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-29 00:00:00.000000000 Z
+date: 2015-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -28,30 +28,30 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: moneta
   requirement: !ruby/object:Gem::Requirement