smashrun-ruby 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9933ab7a4d03fabdde1506b9e11b0c6373db9550
-  data.tar.gz: c4fd2cd6ea33c40da6b1b70b4fc98d2165439213
+  metadata.gz: 5381c533903a6cf6ed9e2feeaf75e21945061bd6
+  data.tar.gz: 62c5c9e78d90d8caac12b912f0294480aa8fad82
 SHA512:
-  metadata.gz: 84bc5dbfb0c45811687fc4f73e51ee9ff6a7dc6b834760d588ea6342afea8f77297d737a701f08611d6e6da12c09607ef035374bfb8b428bdd40307088fefadd
-  data.tar.gz: 1ad401357bd282d2f7773d6cf1d9e8b53a71d9b7c8bc5bdfe1e40266cc7cdde02391f018e43b530b4e7215e5532ba55b1b66f0caf785ddef45cbcdadb11306cc
+  metadata.gz: 0e3f77f0350dec2fdb39eda9fdf8279713e4af0ea99903046f626d8c91f4b57218fd6ca13c003b48533faa0df70e23538b61aa73084cdf1d5438a9155a352638
+  data.tar.gz: bc1d3caa4cc43e8b74377ca62f8edf78fe832f45a22bcf26a173d4fd6da4801b689db30301796d8c1559e6258df5b1fe89d2f5b386134a6321bc2d43058d78b7

data/README.md

@@ -0,0 +1,72 @@
+# smashrun
+
+Ruby gem for [Smashrun api](https://api.smashrun.com/v1/documentation)
+
+Register your application for getting client id and secret: https://api.smashrun.com/register
+
+## Usage
+
+### Authentication
+
+```ruby
+Smashrun.configure do |config|
+  config.client_id = 'your app client id'
+  config.client_secret = 'your app client secret'
+end
+
+client = Smashrun::Client.new(user_access_token)
+```
+
+### Refresh user's access token
+Smashrun tokens are valid for 12 weeks, you can refresh access tokens using user's refresh token. 
+
+```ruby
+client.refresh_token(refresh_token)
+```
+You better save new access token and refresh token.
+
+
+### Fetching activities
+
+```ruby
+client.activities # => list of recent activities
+```
+You can also use **fromDateUTC**, **page** or **count** for filtering and paginating activities list
+
+```ruby
+client.activities page: 1, count: 100
+
+client.activities fromDateUTC: 2.days.ago.to_i, page: 2
+```
+
+If you want to minimize download size or need to quickly check for new activities, use following api methods instead.
+```ruby
+client.latest_activities_briefs # retrive activities with minimal info( id, startTime, distance and duration)
+
+client.latest_activities_ids    # or just ids
+````
+
+
+### Fetching single activity detail
+
+```ruby
+client.activity_detail activity_id        # full activity detail 
+client.activity_svg_polyline activity_id  # retrive SVG polyline for route of activity
+client.activity_geojson activity_id       # retrive activity route in GeoJSON format
+client.activity_splits activity_id, 'distance_unit'        # retrive splits of an activity in specified unit ( mi for mile and km for kilometer)
+````
+
+### Fetching user detail
+```ruby
+client.athlete
+```
+
+### Posting new activities 
+
+Pending...
+ 
+
+## Copyright
+
+Copyright (c) 20117 Naveed Ahmad. See LICENSE.txt for further details.
+

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/lib/smashrun/client.rb

@@ -3,7 +3,7 @@ module Smashrun
     OAUTH_URLS = { site:          'https://api.smashrun.com',
                    authorize_url: 'https://secure.smashrun.com/oauth2/authenticate',
                    token_url:     'https://secure.smashrun.com/oauth2/token'
-    }
+    }.freeze
     
     def initialize(access_token)
       client = OAuth2::Client.new(Smashrun.client_id, Smashrun.client_secret, OAUTH_URLS)
@@ -11,62 +11,63 @@ module Smashrun
       @token = OAuth2::AccessToken.new(client, access_token)
     end
     
-    def get_refresh_token(token)
+    def refresh_token(token)
       @token.refresh_token = token
       @token.refresh!.to_hash
     end
     
-    # Retrieve latest activities
-    def get_activities()
-      Oj.load(@token.get("/v1/my/activities").body)
-    end
-    
     # Filter activities, valid options are: *fromDateUTC*, *page* and *count*
-    def search_activities(params={})
-      Oj.load(@token.get("/v1/my/activities/search", params).body)
+    def activities(params={})
+      uri = params.present? ? "/v1/my/activities/search" : "/v1/my/activities"
+      request uri, params
     end
     
     # Returns the first 100 smashrun run ids.
     def latest_activities_ids
-      Oj.load(@token.get("/v1/my/activities/search/ids").body)
+      request "/v1/my/activities/search/ids"
     end
     
     # Returns an array of json objects containing the runId, startTime, distance (in kilometers), and duration
     def latest_activities_briefs
-      Oj.load(@token.get("/v1/my/activities/search/briefs").body)
+      request "/v1/my/activities/search/briefs"
     end
     
     # To retrieve a Google encoded polyline of a run route to easily draw a route map in Google maps.
     def activity_polyline(activity_id)
-      Oj.load(@token.get("/v1/my/activities/#{activity_id}/polyline").body)
+      request "/v1/my/activities/#{activity_id}/polyline"
     end
-  
+    
     # To retrieve an SVG polyline of a run route.
     def activity_svg_polyline(activity_id)
-      Oj.load(@token.get("/v1/my/activities/#{activity_id}/polyline/svg").body)
+      request "/v1/my/activities/#{activity_id}/polyline/svg"
     end
     
     # To retrieve a GeoJSON representation a run route.
     def activity_geojson(activity_id)
-      Oj.load(@token.get("/v1/my/activities/#{activity_id}/polyline/geojson").body)
+      request "/v1/my/activities/#{activity_id}/polyline/geojson"
     end
-
+    
     # To retrieve a detail of single activity.
     def activity_detail(activity_id)
-      Oj.load(@token.get("/v1/my/activities/#{activity_id}").body)
+      request "/v1/my/activities/#{activity_id}"
     end
-
+    
     # Retrive activity splits
     def activity_splits(activity_id, unit)
       unless ['km', 'mi'].include?(unit)
         raise ArgumentError.new("Invlaid distance unit for splits. Valid units are km or mi")
       end
-      
-      Oj.load(@token.get("/v1/my/activities/#{activity_id}/splits/#{unit}").body)
+
+      request "/v1/my/activities/#{activity_id}/splits/#{unit}"
+    end
+    
+    def athlete
+      request "/v1/my/userinfo"
     end
     
-    def profile_info
-      Oj.load(@token.get("/v1/my/userinfo").body)
+    protected
+    def request(uri, params={})
+      Oj.load @token.get(uri, params).body
     end
   end
 end

data/smashrun-ruby.gemspec

@@ -2,28 +2,28 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: smashrun-ruby 0.1.2 ruby lib
+# stub: smashrun-ruby 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "smashrun-ruby"
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Naveed Ahmad"]
-  s.date = "2017-10-02"
+  s.date = "2017-10-03"
   s.description = "Ruby gem for Smashrun api"
   s.email = "naveedahmada036@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "lib/smashrun.rb",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smashrun-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Naveed Ahmad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-02 00:00:00.000000000 Z
+date: 2017-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -100,13 +100,13 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - ".document"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - lib/smashrun.rb

data/README.rdoc

@@ -1,19 +0,0 @@
-= smashrun
-
-Description goes here.
-
-== Contributing to smashrun
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2017 Naveed Ahmad. See LICENSE.txt for
-further details.
-