velibe 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2961ad36ef9de68b90ad01c7f57f920e49f74ac
-  data.tar.gz: 12ec6625b623911df17ec26639031044d3fa3a6b
+  metadata.gz: 77f7f5b9baaec5d5a804ff15b0a344df335be84b
+  data.tar.gz: d2bfd4d5d77d941a68033ee17cf63b98faac404d
 SHA512:
-  metadata.gz: fb69057de4323e003c95cfc3aaa5e20a6b0f34752a5ad83f5824f15e5416853035e457267d5727cff47013db528bbc44b5c36c11fe06aadd635e51f481d5620f
-  data.tar.gz: 742e5306b09c31d5cd62517cc55eb7b25579858bd57ea47a1a72eaeecff35947ec3def01b59961f60eec8dd937da49df10f9c7b6485cccd1aa659fa1cf7bdb65
+  metadata.gz: a721e24aa50e2928b6fc60296142fa6c79d2aeaf653760f116d8307f1ecd3672c7ed1a8555bb90d32bbd84910e3968191eea59587e56507350ca94097e388075
+  data.tar.gz: 0781a73c8ae7f37ce033996c5bcdeaf1e4226feba15bb8c8bc99eeb90119d9af5ddb2e0199f4c92f9a36ad428caa47bc7c03765590ebfdc77d0aa424d1afdc14

data/.travis.yml

@@ -1,4 +1,7 @@
 language: ruby
+sudo: false
+cache: bundler
+
 rvm:
   - 2.0.0
   - 2.1

data/CHANGELOG.md

@@ -5,8 +5,13 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
 
-## [0.1.0] - 2015-11-18
+## [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)
+
+## [0.1.0] - 2015-11-18
 ### Changed
 - Token must be specified with the `VELIBE_TOKEN` environment variable.
 
@@ -22,7 +27,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.1.0...HEAD
+[unreleased]: https://github.com/AdrieanKhisbe/velibe/compare/v0.2.0...HEAD
+[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
 [0.0.1]: https://github.com/AdrieanKhisbe/velibe/compare/02a6045....v0.10

data/CONTRIBUTING.md

@@ -0,0 +1,20 @@
+# Contributing
+
+## Issue Reporting
+
+Issue report are more than welcome, but to be efficiently handle you should
+include your ruby version and a stacktrace.
+
+## Proposal of Features
+If there is a feature you would like to be added, just suggest it.
+
+If you want to implement it yourself, I stringly recommand you to talk
+about it first, posting a issue describing the intentinded feature,
+and the main ideas about how you would implement it.
+
+## Development
+1. Fork it ( https://github.com/[my-github-username]/VeLibe/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 a new Pull Request

data/README.md

@@ -22,6 +22,8 @@ Just install the gem, and you'll have access to this wonderful tool :D
 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]
 (https://developer.jcdecaux.com/#/opendata/vls?page=dynamic).
+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.
 

data/bin/velibe

@@ -1,10 +1,29 @@
 #!/usr/bin/env ruby
 # -*- coding: utf-8 -*-
-## My Velib Querier
+## My Velib Querrier
 
 require 'velibe'
 
-## Main
-Velibe.print_stations(ARGV)
+case ARGV[0]
+  when /f(av(orite)?)?$/
+    # handle favorites
+    case ARGV[1]
+      when /a(dd)?/
+        stations = ARGV[2..-1]
+        # TODO: check if all number
+        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
+          puts 'Favorites not empty, you need to add --force/-f flag if you really want to reset'
+        end
+      else
+        Velibe.print_favorites
+    end
 
-# garder sta à gauche du chevron?
+  else
+    # TODO: check if all number
+    Velibe.print_stations(ARGV)
+end

data/lib/velibe.rb

@@ -4,17 +4,21 @@ require 'velibe/api_velib'
 require 'velibe/station_status'
 require 'velibe/db/database'
 require 'velibe/db/models'
+require 'velibe/db/kv_store'
 
 module Velibe
 
   # Default values > Move
-  Favorites = [10035, 19003, 19004, 10031]
+  tmp_fav = KvStore.favorite_stations
+  Favorites = tmp_fav.nil? ? [10035, 19003, 19004, 10031] : tmp_fav
 
   # TODO: try catch network exception
   # TODO lazy singleton!!
 
+  # TODO extract cli class, and include!
   # §maybe: class CLI
 
+
   def self.print_stations(stations)
     stations = Favorites if stations.empty? or !stations
     puts "Velibe >> Stations #{stations.join(', ')}:"
@@ -26,6 +30,26 @@ module Velibe
     puts "Velibe >> Stations #{stations.join(', ')}:"
     ApiVelib.get_stations(stations) { |station| StationStatus.print_from_json(station, '        > ') }
   end
+
   # TODO: Bench both?
 
+
+  def self.print_favorites
+    if Favorites.empty?
+      puts 'No favorites so far, you can add some with `velibe favorite add <your> <number>`.'
+    else
+      puts "Favorites Stations: #{Favorites.join(', ')}"
+    # TODO: print details with db
+    end
+  end
+
+  def self.reset_favorites(force = false)
+    KvStore.reset_favorite_stations if force or KvStore.favorite_stations.empty?
+  end
+
+  def self.add_favorite(stations)
+    KvStore.add_favorite_station(*stations)
+  end
+
+
 end

data/lib/velibe/api_velib.rb

@@ -5,10 +5,10 @@ require 'json'
 module Velibe
   class ApiVelib
 
-    API_KEY = ENV['VELIBE_TOKEN'] || raise('No token provided')
+    API_KEY = ENV['VELIBE_TOKEN'] || KvStore.token || raise('No token provided')
 
     API_HOST = 'https://api.jcdecaux.com'
-    API_PARAM= { contract: 'paris', apiKey: API_KEY }
+    API_PARAM = { contract: 'paris', apiKey: API_KEY }
     API_BASE_URI = '/vls/v1/stations'
 
     def self.get_station(station_number)

data/lib/velibe/db/kv_store.rb

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+require 'moneta'
+
+module Velibe
+
+  module KvStore
+    NAME = '~/.velib.yaml' # TODO: more generic
+    PATH = Pathname.new(NAME).expand_path
+    DB = Moneta.new(:YAML, file: PATH)
+
+    FAV_KEY = 'favorites'
+
+    def self.token
+      DB['token']
+    end
+
+    def self.reset_favorite_stations
+      DB[FAV_KEY] = []
+    end
+
+    def self.favorite_stations
+      DB[FAV_KEY]
+    end
+
+    def self.add_favorite_station(*stations)
+      fav = DB[FAV_KEY]
+      # TODO: handle setup
+      # TODO: check existing station
+      stations.each { |station| fav.push(station) unless fav.include?(station) }
+      DB[FAV_KEY] = fav
+    end
+
+  end
+end

data/lib/velibe/version.rb

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

data/velibe.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = 'velibe'
   spec.version       = Velibe::VERSION
   spec.authors       = ['Adriean Khisbe']
-  spec.email         = ["adriean.khisbe@live.fr"]
+  spec.email         = ['adriean.khisbe@live.fr']
   spec.summary       = %q{Small Velib Utility}
   spec.description   = %q{Wrapper for Velib api, for no-fuss cycling}
   spec.homepage      = 'https://github.com/AdrieanKhisbe/velibe' 
@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'http', '~> 0.9.8'
   spec.add_dependency 'sqlite3'
   spec.add_dependency 'activerecord'
+  spec.add_dependency 'moneta', '~> 0.8'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: velibe
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Adriean Khisbe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-19 00:00:00.000000000 Z
+date: 2015-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: moneta
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +178,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -174,6 +189,7 @@ files:
 - lib/velibe.rb
 - lib/velibe/api_velib.rb
 - lib/velibe/db/database.rb
+- lib/velibe/db/kv_store.rb
 - lib/velibe/db/models.rb
 - lib/velibe/station_status.rb
 - lib/velibe/version.rb