my_bcycle 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19c2141c1b52c900e79f6bffd3924558df52476a
-  data.tar.gz: 6ed32f4d4f9abfa5e752043275ce9215ed8506d7
+  metadata.gz: fa39e4e6cd30525b88ebf6e8390ec26efde02937
+  data.tar.gz: 6e06c3ce1586491272465218f5194c4aa52bf123
 SHA512:
-  metadata.gz: 6bff6c1d287312bfa2584c51bfc4c84a20d629864d7b25072eda3d28de9594f105be26e0d6ceaa3633d21e3519158070e4dadd064592366289fca5611e5c961c
-  data.tar.gz: 50540ddfbb017b3edbe577d602e42bdf2b80c362a993427aff5fcdb9ad0e42df73b6a0422982ef719e9c41e1117b3473325f80dbfe10898b9550cac0739adf83
+  metadata.gz: 4747c39c4ad110ec5e7ce3b286d7a8e9c97c2b40f0397191d5c39391c6d09156a1d198dfde8916a938e0f282504f7068276e736575e278ead3448b6234e225bf
+  data.tar.gz: c56db5c896135271bf58b3ecc87455c727bf0ec8f2f68e27f4546fdae632df61deded66b7a2ee26c5108a76f3a50c3f2e31aa89c68f9e2a7e09a5df5bd2d0cff

data/.rubocop.yml

@@ -17,7 +17,9 @@ Style/StringLiteralsInInterpolation:
     - single_quotes
     - double_quotes
 Metrics/LineLength:
-    Max: 90
+  Max: 90
+Metrics/MethodLength:
+  Max: 15
 Documentation:
   Enabled: false
 Style/DoubleNegation:
@@ -26,4 +28,9 @@ Style/MultilineBlockChain:
   Enabled: false
 Style/FrozenStringLiteralComment:
   Enabled: false
-
+Style/GuardClause:
+  Enabled: false
+TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+Style/IfUnlessModifier:
+  Enabled: false

data/Gemfile

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

data/README.md

@@ -1,8 +1,5 @@
-# MyBcycle
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/my_bcycle`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+## Description
+This gem wraps bcycle personal statistics api to provider statistics for specific user. Currently only Austin is tested and supported but it might work for other cities where bcycle is operating. 
 
 ## Installation
 
@@ -22,8 +19,18 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
-
+```ruby
+me = MyBcycle::User.new(
+  username: "me",
+  password: "secret"
+)
+me.statistics_for(Time.parse('2016-05-01')) =>
+  "2001-01-01 01:01:01.01Z" => {
+  miles: 999.80,
+  duration: 22,
+  money_saved: 1.5
+}
+```
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -32,7 +39,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/my_bcycle.
+Bug reports and pull requests are welcome on GitHub at https://github.com/tsubery/my_bcycle.
 
 
 ## License

data/Rakefile

@@ -3,4 +3,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/my_bcycle.rb

@@ -1,4 +1,5 @@
 require "my_bcycle/version"
+require "typhoeus"
 
 module MyBcycle
   InvalidCredentials = Class.new(StandardError)
@@ -6,7 +7,7 @@ module MyBcycle
 
   class User
     attr_reader :username, :password, :city
-    def initialize city: :austin, username:, password:
+    def initialize(city: :austin, username:, password:)
       @city = city
       @username = username
       @password = password
@@ -14,63 +15,70 @@ module MyBcycle
 
     def statistics_for(time)
       return unless session_token
-      response = Typhoeus.get(
-        'https://portal-den.bcycle.com/1/user/trips',
+      response = do_request! Typhoeus::Request.new(
+        "https://portal-den.bcycle.com/1/user/trips",
         params: {
           month: time.month,
-          year: time.year
+          year: time.year,
         },
-        headers: {'Bcycle-Session-Token': session_token },
+        headers: { 'Bcycle-Session-Token': session_token },
         accept_encoding: "gzip"
       )
-      unless response.code == 200
-        raise "todo"
-      end
-      month_data = JSON.parse(response.body)
-      month_data.map do |entry|
+      parse_statistics(response.body)
+    end
+
+    private
+
+    def parse_statistics(body)
+      JSON.parse(body).map do |entry|
         k = Time.parse entry["checkOutDate"]
         v = {
           miles:  entry["miles"],
           duration:  entry["duration"],
           money_saved:  entry["moneySaved"],
         }
-        [ k, v ]
+        [k, v]
       end.to_h
     end
 
-    private
     def session_token
       @session_token ||= retrieve_token
     end
 
     def retrieve_token
-      cookiefile = Tempfile.new('bcycle-cookie')
+      cookiefile = Tempfile.new("bcycle-cookie")
       cookie_path = cookiefile.path
       begin
-        login_req = do_request! Typhoeus::Request.new(
-          login_url,
-          method: :post,
-          cookiefile: cookie_path,
-          cookiejar: cookie_path,
-          body: login_params
-        )
-        if login_req.body.match(/Invalid UserName/i)
-          raise InvalidCredentials
-        end
-
-        token_req = do_request! Typhoeus::Request.new(
-          token_url,
-          cookiefile: cookie_path,
-          cookiejar: cookie_path,
-        )
-        token_req.body[/\A"([a-z0-9\-]{36})"/i, 1]
+        login_request!(cookie_path)
+        token_request!(cookie_path).body[/\A"([a-z0-9\-]{36})"/i, 1]
       end
     ensure
       cookiefile.close
       cookiefile.unlink
     end
 
-    def do_request! request
+    def login_request!(cookie_path)
+      login_req = do_request! Typhoeus::Request.new(
+        login_url,
+        method: :post,
+        cookiefile: cookie_path,
+        cookiejar: cookie_path,
+        body: login_params
+      )
+      if login_req.body =~ /Invalid UserName/i
+        raise InvalidCredentials
+      end
+    end
+
+    def token_request!(cookie_path)
+      do_request! Typhoeus::Request.new(
+        token_url,
+        cookiefile: cookie_path,
+        cookiejar: cookie_path
+      )
+    end
+
+    def do_request!(request)
       request.on_complete do |response|
         next if response.success?
 
@@ -79,25 +87,25 @@ module MyBcycle
         elsif response.code == 0
           raise CommunicationProblem, response.return_message.to_s
         else
-          raise CommunicationProblem, "Got error code #{response.code.to_s}"
+          raise CommunicationProblem, "Got error code #{response.code}"
         end
       end
       request.run
     end
 
-      def login_url
-        "https://#{city}.bcycle.com/api/Authenticate"
-      end
+    def login_url
+      "https://#{city}.bcycle.com/api/Authenticate"
+    end
 
-      def token_url
-        "https://#{city}.bcycle.com/api/sessiontoken/get"
-      end
+    def token_url
+      "https://#{city}.bcycle.com/api/sessiontoken/get"
+    end
 
-      def login_params
-        {
-          UserName: username,
-          Password: password
-        }
-      end
+    def login_params
+      {
+        UserName: username,
+        Password: password,
+      }
     end
+  end
 end

data/lib/my_bcycle/version.rb

@@ -1,3 +1,3 @@
 module MyBcycle
-  VERSION = "0.1.0"
+  VERSION = "0.1.1".freeze
 end

data/my_bcycle.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'my_bcycle/version'
+require "my_bcycle/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "my_bcycle"
@@ -10,11 +10,13 @@ Gem::Specification.new do |spec|
   spec.email         = ["gal.tsubery@gmail.com"]
 
   spec.summary       = "Wrapper of bcycle personal usage statistics API"
-  spec.description   = "This gem retrieves bcycle personal usage statistics from their website, including total miles, duration and money saved."
+  spec.description   = "This gem retrieves bcycle personal usage statistics"\
+  " from their website, including total miles, duration and money saved."
   spec.homepage      = "http://github.com/tsubery/my_bcycle/"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`
+                       .split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: my_bcycle
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Gal Tsubery
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-15 00:00:00.000000000 Z
+date: 2016-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler