nike_v2 0.3.0 → 0.3.1

data/Gemfile

@@ -1,2 +1,3 @@
 source :rubygems
-gemspec
+gemspec
+gem 'debugger'

data/README.md

@@ -49,6 +49,27 @@ person.activities.total_fuel #fetches the metrics if they aren't already loaded
  => 394
 ```
 
+As of version 0.3.0 you can cache calls to the Nike+ V2 api.  We use the ApiCache (https://github.com/mloughran/api_cache) gem for this and all options in cache directive are passed to the api_cache config.  Setting config.cache false disables the cache
+``` ruby
+# config/initializers/nike_v2.rb
+NikeV2.configure do |config|
+  config.cache = {
+    :cache => 3600
+  }
+end
+```
+
+Possible options:
+```
+{
+  :cache => 600,    # 10 minutes  After this time fetch new data
+  :valid => 86400,  # 1 day       Maximum time to use old data
+                    #             :forever is a valid option
+  :period => 60,    # 1 minute    Maximum frequency to call API
+  :timeout => 5     # 5 seconds   API response timeout
+  :fail =>          # Value returned instead of exception on failure
+}
+```
 ## Making it Better
  
 * Fork the project.

data/lib/nike_v2/activities.rb

@@ -42,15 +42,21 @@ module NikeV2
     end
 
     def fetch_more
-      unless self.paging['next'].blank?
+      unless self.paging['next'].nil? || self.paging['next'] == ''
         fetch_and_build_activities 
       end
+      self
     end
 
     def fetch_all
-      until self.paging['next'].blank? do
+      until (self.paging['next'].nil? || self.paging['next'] == '') do
         fetch_and_build_activities 
       end
+      self
+    end
+
+    def paging
+      @paging ||= ''
     end
 
     private

data/lib/nike_v2/version.rb

@@ -1,3 +1,3 @@
 module NikeV2
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/spec/fixtures/nike_api_cassettes/activities.yml

@@ -30,7 +30,7 @@ http_interactions:
       - keep-alive
     body:
       encoding: US-ASCII
-      string: ! '{"data":[{"activityId":"91b501dc-4a38-44aa-b537-6095418713d8","calories":2475,"fuel":7500,"distance":19.665315,"steps":24975,"duration":"0:01:00.0000","activityType":"ALL_DAY","startTime":"2012-02-26T08:00:00Z","activityTimeZone":"America/Los_Angeles","status":"COMPLETE","deviceType":"FUELBAND","tags":[],"streams":[],"metrics":[]},{"activityId":"8554c3bb-f985-4700-a52d-6235475a10f0","calories":1848,"fuel":5555,"distance":14.6834352,"steps":18648,"duration":"0:01:00.0000","activityType":"ALL_DAY","startTime":"2012-02-25T08:00:00Z","activityTimeZone":"America/Los_Angeles","status":"COMPLETE","deviceType":"FUELBAND","tags":[],"streams":[]},{"activityId":"b7511567-9414-429a-9b7b-40ebc15af985","calories":396,"fuel":1200,"distance":3.1464504,"steps":3996,"duration":"0:01:00.0000","activityType":"ALL_DAY","startTime":"2012-02-24T08:00:00Z","activityTimeZone":"America/Los_Angeles","status":"COMPLETE","deviceType":"FUELBAND","tags":[],"streams":[]},{"activityId":"b87bb409-a618-47ee-a75e-1bb5f8daf9a6","calories":300,"fuel":900,"distance":2.3621999999999996,"steps":3000,"duration":"0:01:00.0000","activityType":"ALL_DAY","startTime":"2012-02-23T08:00:00Z","activityTimeZone":"America/Los_Angeles","status":"COMPLETE","deviceType":"FUELBAND","tags":[],"streams":[]},{"activityId":"6c6eb89c-fa42-49a6-8b04-2596297a7c3a","calories":200,"fuel":600,"distance":1.5748,"steps":2000,"duration":"0:01:00.0000","activityType":"ALL_DAY","startTime":"2012-02-22T08:00:00Z","activityTimeZone":"America/Los_Angeles","status":"COMPLETE","deviceType":"FUELBAND","tags":[],"streams":[]}],"paging":{"next":"/me/sport/activities?access_token=68d1b7f5ec3e6a1ad3b349cd73983b34&offset=6&count=5","previous":null}}'
+      string: ! '{"data":[{"activityId":"91b501dc-4a38-44aa-b537-6095418713d8","calories":2475,"fuel":7500,"distance":19.665315,"steps":24975,"duration":"0:01:00.0000","activityType":"ALL_DAY","startTime":"2012-02-26T08:00:00Z","activityTimeZone":"America/Los_Angeles","status":"COMPLETE","deviceType":"FUELBAND","tags":[],"streams":[],"metrics":[]},{"activityId":"8554c3bb-f985-4700-a52d-6235475a10f0","calories":1848,"fuel":5555,"distance":14.6834352,"steps":18648,"duration":"0:01:00.0000","activityType":"ALL_DAY","startTime":"2012-02-25T08:00:00Z","activityTimeZone":"America/Los_Angeles","status":"COMPLETE","deviceType":"FUELBAND","tags":[],"streams":[]},{"activityId":"b7511567-9414-429a-9b7b-40ebc15af985","calories":396,"fuel":1200,"distance":3.1464504,"steps":3996,"duration":"0:01:00.0000","activityType":"ALL_DAY","startTime":"2012-02-24T08:00:00Z","activityTimeZone":"America/Los_Angeles","status":"COMPLETE","deviceType":"FUELBAND","tags":[],"streams":[]},{"activityId":"b87bb409-a618-47ee-a75e-1bb5f8daf9a6","calories":300,"fuel":900,"distance":2.3621999999999996,"steps":3000,"duration":"0:01:00.0000","activityType":"ALL_DAY","startTime":"2012-02-23T08:00:00Z","activityTimeZone":"America/Los_Angeles","status":"COMPLETE","deviceType":"FUELBAND","tags":[],"streams":[]},{"activityId":"6c6eb89c-fa42-49a6-8b04-2596297a7c3a","calories":200,"fuel":600,"distance":1.5748,"steps":2000,"duration":"0:01:00.0000","activityType":"ALL_DAY","startTime":"2012-02-22T08:00:00Z","activityTimeZone":"America/Los_Angeles","status":"COMPLETE","deviceType":"FUELBAND","tags":[],"streams":[]}],"paging":{"next":"/me/sport/activities?access_token=foobar&offset=6&count=5","previous":null}}'
     http_version: 
   recorded_at: Sun, 20 Jan 2013 04:21:05 GMT
 - request:
@@ -67,7 +67,7 @@ http_interactions:
         "calories": 581, "fuel": 1653, "distance": 2.0936965942382812, "steps": 2659,
         "duration": "7:02:00.000", "activityType": "ALL_DAY", "startTime": "2013-02-26T07:00:00Z",
         "activityTimeZone": "America/Phoenix", "status": "IN_PROGRESS", "deviceType":
-        "FUELBAND", "tags": [], "metrics": [] } ], "paging": { "next": "/me/sport/activities?count=1&access_token=2159f27a88a8cc3b410e1529412b86f5&offset=2"
+        "FUELBAND", "tags": [], "metrics": [] } ], "paging": { "next": "/me/sport/activities?count=1&access_token=foobar&offset=2"
         } }'
     http_version: 
   recorded_at: Wed, 27 Feb 2013 16:18:07 GMT
@@ -105,7 +105,7 @@ http_interactions:
         "calories": 581, "fuel": 1653, "distance": 2.0936965942382812, "steps": 2659,
         "duration": "7:02:00.000", "activityType": "ALL_DAY", "startTime": "2013-01-01T07:00:00Z",
         "activityTimeZone": "America/Phoenix", "status": "IN_PROGRESS", "deviceType":
-        "FUELBAND", "tags": [], "metrics": [] } ], "paging": { "next": "/me/sport/activities?startDate=2013-01-01&access_token=2159f27a88a8cc3b410e1529412b86f5&offset=2"
+        "FUELBAND", "tags": [], "metrics": [] } ], "paging": { "next": "/me/sport/activities?startDate=2013-01-01&access_token=foobar&offset=2"
         } }'
     http_version: 
   recorded_at: Wed, 27 Feb 2013 16:18:07 GMT
@@ -259,4 +259,80 @@ http_interactions:
         "4", "25", "22", "19", "11", "2", "23" ] } ] }'
     http_version: 
   recorded_at: Sun, 20 Jan 2013 04:21:05 GMT
+- request:
+    method: get
+    uri: https://api.nike.com/me/sport/activities?access_token=foobar&count=1&offset=2
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Appid:
+      - nike
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json;charset=UTF-8
+      Date:
+      - Sun, 20 Jan 2013 04:21:04 GMT
+      Server:
+      - Apache
+      X-Swooshlet:
+      - app-msp-api-0 prd sin-82-app-msp-api-0
+      Content-Length:
+      - '340'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{ "data": [ { "activityId": "c3337642-72db-41f7-b4a2-4da4600dfc91",
+        "calories": 581, "fuel": 1653, "distance": 2.0936965942382812, "steps": 2659,
+        "duration": "7:02:00.000", "activityType": "ALL_DAY", "startTime": "2013-02-26T07:00:00Z",
+        "activityTimeZone": "America/Phoenix", "status": "IN_PROGRESS", "deviceType":
+        "FUELBAND", "tags": [], "metrics": [] } ], "paging": { "next": "/me/sport/activities?count=1&access_token=foobar&offset=3"
+        } }'
+    http_version: 
+  recorded_at: Thu, 14 Mar 2013 00:45:14 GMT
+- request:
+    method: get
+    uri: https://api.nike.com/me/sport/activities?access_token=foobar&count=1&offset=3
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Appid:
+      - nike
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json;charset=UTF-8
+      Date:
+      - Sun, 20 Jan 2013 04:21:04 GMT
+      Server:
+      - Apache
+      X-Swooshlet:
+      - app-msp-api-0 prd sin-82-app-msp-api-0
+      Content-Length:
+      - '340'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{ "data": [ { "activityId": "c3337642-72db-41f7-b4a2-4da4600dfc92",
+        "calories": 581, "fuel": 1653, "distance": 2.0936965942382812, "steps": 2659,
+        "duration": "7:02:00.000", "activityType": "ALL_DAY", "startTime": "2013-02-26T07:00:00Z",
+        "activityTimeZone": "America/Phoenix", "status": "IN_PROGRESS", "deviceType":
+        "FUELBAND", "tags": [], "metrics": [] } ], "paging": { 
+        } }'
+    http_version: 
+  recorded_at: Thu, 14 Mar 2013 00:45:14 GMT
 recorded_with: VCR 2.4.0

data/spec/nike_v2/acitivites_spec.rb

@@ -19,6 +19,12 @@ describe NikeV2::Activities do
       person.activities(:count => 1).length.should == 1
     end
 
+    it 'should fetch_all and return an array of Nike::Activity' do
+      (a = person.activities(:count => 1).fetch_all).should be_kind_of(NikeV2::Activities)
+      a.first.should be_kind_of(NikeV2::Activity)
+      a.length.should == 3
+    end
+
     it 'should accept the start_date parameter, camelcase it and return an array of Nike::Activity' do
       pending
       # person.activities(:count => 1).should be_kind_of(NikeV2::Activities)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nike_v2
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors: