smashrun-ruby 0.1.2 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9933ab7a4d03fabdde1506b9e11b0c6373db9550
-  data.tar.gz: c4fd2cd6ea33c40da6b1b70b4fc98d2165439213
+SHA256:
+  metadata.gz: 4fc507695124aea34f2f5eb47c5003ccf6d75271b4d9d49b58c8041f26021e99
+  data.tar.gz: f2900b63167fd19c44e92e4b0655a91dbfee175bfc4c4cfc548193bcd6477d1a
 SHA512:
-  metadata.gz: 84bc5dbfb0c45811687fc4f73e51ee9ff6a7dc6b834760d588ea6342afea8f77297d737a701f08611d6e6da12c09607ef035374bfb8b428bdd40307088fefadd
-  data.tar.gz: 1ad401357bd282d2f7773d6cf1d9e8b53a71d9b7c8bc5bdfe1e40266cc7cdde02391f018e43b530b4e7215e5532ba55b1b66f0caf785ddef45cbcdadb11306cc
+  metadata.gz: f84d14ee7f124a41cf7e4260e3a2e9198dca69193a29e99e3f68ffcabaa150e52a7d28c74d5b4598eefe835246b16ba582e391861e172ec9e19aa6440b02c80a
+  data.tar.gz: d842ec667a71afd8fcdf26c249748803b83a9c1e3aa89720cd43caab6ad4c027536e9089d114313dbf5950bcc32f4a5096f3af56801f1e905a0ca8f8506f19be

data/.github/workflows/gempush.yml

@@ -0,0 +1,45 @@
+name: Ruby Gem
+
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        version: 2.6.x
+
+    - name: Publish to GPR
+      run: echo pending
+      # run: |
+      #  mkdir -p $HOME/.gem
+      #  touch $HOME/.gem/credentials
+      #  chmod 0600 $HOME/.gem/credentials
+      #  printf -- "---\n:github: Bearer ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+      #  gem build *.gemspec
+      #  gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.GPR_AUTH_TOKEN}}
+        OWNER: naveed-ahmad
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/Gemfile

@@ -5,7 +5,7 @@ source "https://rubygems.org"
 
 source 'https://rubygems.org'
 gem 'oauth2', '~> 1.4.0'
-gem 'oj', '~> 3.3.5'
+gem 'oj', '~> 3.9.1'
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
@@ -13,5 +13,4 @@ group :development do
   gem "rdoc", "~> 3.12"
   gem "bundler", "~> 1.0"
   gem "juwelier", "~> 2.1.0"
-  gem "simplecov", ">= 0"
 end

data/Gemfile.lock

@@ -5,7 +5,6 @@ GEM
     builder (3.2.3)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
-    docile (1.1.5)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
     git (1.3.0)
@@ -31,29 +30,26 @@ GEM
       semver
     jwt (1.5.6)
     mime-types (2.99.3)
-    mini_portile2 (2.3.0)
+    mini_portile2 (2.5.0)
     multi_json (1.12.2)
     multi_xml (0.6.0)
     multipart-post (2.0.0)
-    nokogiri (1.8.1)
-      mini_portile2 (~> 2.3.0)
+    nokogiri (1.11.1)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
     oauth2 (1.4.0)
       faraday (>= 0.8, < 0.13)
       jwt (~> 1.0)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
-    oj (3.3.6)
-    rack (2.0.3)
-    rake (12.1.0)
+    oj (3.9.1)
+    racc (1.5.2)
+    rack (2.2.3)
+    rake (13.0.3)
     rdoc (3.12.2)
       json (~> 1.4)
     semver (1.0.1)
-    simplecov (0.15.1)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
     thread_safe (0.3.6)
 
 PLATFORMS
@@ -63,9 +59,8 @@ DEPENDENCIES
   bundler (~> 1.0)
   juwelier (~> 2.1.0)
   oauth2 (~> 1.4.0)
-  oj (~> 3.3.5)
+  oj (~> 3.9.1)
   rdoc (~> 3.12)
-  simplecov
 
 BUNDLED WITH
-   1.13.7
+   1.17.2

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/Rakefile

@@ -14,13 +14,13 @@ require 'juwelier'
 Juwelier::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
   gem.name = "smashrun-ruby"
-  gem.homepage = "http://github.com/naveed-ahmad/smashrun"
+  gem.homepage = "http://github.com/naveed-ahmad/smashrun-ruby"
   gem.license = "MIT"
   gem.summary = "Ruby gem for Smashrun api"
   gem.description = gem.summary
   gem.email = "naveedahmada036@gmail.com"
   gem.authors = ["Naveed Ahmad"]
-  
+
   # dependencies defined in Gemfile
 end
 Juwelier::RubygemsDotOrgTasks.new
@@ -31,18 +31,12 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-desc "Code coverage detail"
-task :simplecov do
-  ENV['COVERAGE'] = "true"
-  Rake::Task['test'].execute
-end
-
 task :default => :test
 
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
-  
+
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "smashrun-ruby #{version}"
   rdoc.rdoc_files.include('README*')

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.3.2

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: params).body
     end
   end
 end

data/smashrun-ruby.gemspec

@@ -2,28 +2,29 @@
 # 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.3.1 ruby lib
 
 Gem::Specification.new do |s|
-  s.name = "smashrun-ruby"
-  s.version = "0.1.2"
+  s.name = "smashrun-ruby".freeze
+  s.version = "0.3.2"
 
-  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.description = "Ruby gem for Smashrun api"
-  s.email = "naveedahmada036@gmail.com"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Naveed Ahmad".freeze]
+  s.date = "2019-09-14"
+  s.description = "Ruby gem for Smashrun api".freeze
+  s.email = "naveedahmada036@gmail.com".freeze
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
+    ".github/workflows/gempush.yml",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "lib/smashrun.rb",
@@ -33,36 +34,33 @@ Gem::Specification.new do |s|
     "test/helper.rb",
     "test/test_smashrun.rb"
   ]
-  s.homepage = "http://github.com/naveed-ahmad/smashrun"
-  s.licenses = ["MIT"]
-  s.rubygems_version = "2.4.8"
-  s.summary = "Ruby gem for Smashrun api"
+  s.homepage = "http://github.com/naveed-ahmad/smashrun-ruby".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "3.0.3".freeze
+  s.summary = "Ruby gem for Smashrun api".freeze
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<oauth2>, ["~> 1.4.0"])
-      s.add_runtime_dependency(%q<oj>, ["~> 3.3.5"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_development_dependency(%q<juwelier>, ["~> 2.1.0"])
-      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_runtime_dependency(%q<oauth2>.freeze, ["~> 1.4.0"])
+      s.add_runtime_dependency(%q<oj>.freeze, ["~> 3.10.2"])
+      s.add_development_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>.freeze, ["~> 1.0"])
+      s.add_development_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
     else
-      s.add_dependency(%q<oauth2>, ["~> 1.4.0"])
-      s.add_dependency(%q<oj>, ["~> 3.3.5"])
-      s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_dependency(%q<juwelier>, ["~> 2.1.0"])
-      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<oauth2>.freeze, ["~> 1.4.0"])
+      s.add_dependency(%q<oj>.freeze, ["~> 3.10.2"])
+      s.add_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+      s.add_dependency(%q<bundler>.freeze, ["~> 1.0"])
+      s.add_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
     end
   else
-    s.add_dependency(%q<oauth2>, ["~> 1.4.0"])
-    s.add_dependency(%q<oj>, ["~> 3.3.5"])
-    s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<bundler>, ["~> 1.0"])
-    s.add_dependency(%q<juwelier>, ["~> 2.1.0"])
-    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<oauth2>.freeze, ["~> 1.4.0"])
+    s.add_dependency(%q<oj>.freeze, ["~> 3.10.2"])
+    s.add_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+    s.add_dependency(%q<bundler>.freeze, ["~> 1.0"])
+    s.add_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smashrun-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.2
 platform: ruby
 authors:
 - Naveed Ahmad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-02 00:00:00.000000000 Z
+date: 2019-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.5
+        version: 3.10.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.5
+        version: 3.10.2
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -80,33 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.1.0
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Ruby gem for Smashrun api
 email: naveedahmada036@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - ".document"
+- ".github/workflows/gempush.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - lib/smashrun.rb
@@ -115,7 +102,7 @@ files:
 - smashrun-ruby.gemspec
 - test/helper.rb
 - test/test_smashrun.rb
-homepage: http://github.com/naveed-ahmad/smashrun
+homepage: http://github.com/naveed-ahmad/smashrun-ruby
 licenses:
 - MIT
 metadata: {}
@@ -134,8 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Ruby gem for Smashrun api

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.
-