mini_strava 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3fe815926d04faf11099a80f03e0b8a600aeec83
+  data.tar.gz: 4ea64770e09e52df2c0992f501fd1d6f62f46445
+SHA512:
+  metadata.gz: e1ab20bf97b537d815007926b2844e9a9ce0d258d67166c77bed2878a120ac6adbac6a5cca393e2e56dce6261b7dbf12a62e0e4e49bfe00e083855fece1bf36c
+  data.tar.gz: 6f53c3fca48c184efd6e3d6afc0f087ef5dce56b085f7a1faaa85d15c37ad66674d8d2faa8f7a46d675776cfd44904b50442f355b67f419bfa222d5272e206f1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrea Franz
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,63 @@
+# MiniStrava
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mini_strava'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mini_strava
+
+## Usage
+
+    > client = MiniStrava::Client.new 'XYZ'
+    => #<MiniStrava::Client:0x007fb42924a380 @access_token="XYZ">
+
+    > a = client.athlete
+    > a.firstname
+    => "Andrea"
+
+    > a.bikes.first.name
+    => 'Giant TCR'
+
+    > activities = client.activities
+    > activities.first.average_speed
+    => 6.347
+
+    > act = client.activity activities[0].id
+    > act.name
+    => 'Evening ride'
+    > act.distance
+    => 24727.3
+
+Check the Strava API documentation to know more about the available fields for each resource.
+
+### CLI
+
+An executable called `mini-strava` will be installed with the gem. To use it, set the `STRAVA_ACCESS_TOKEN` env variable:
+
+    export STRAVA_ACCESS_TOKEN="xyz"
+
+and then use the CLI:
+
+    $ mini-strava
+    MiniStrava CLI > athlete.firstname
+    => "Andrea"
+    MiniStrava CLI > activities.first.name
+    => "Evening Ride"
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/mini_strava/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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/mini-strava

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+require 'mini_strava'
+require 'ripl'
+require 'delegate'
+
+class CLI < SimpleDelegator
+  attr_reader :client
+
+  def initialize
+    @client = MiniStrava::Client.new ENV['STRAVA_ACCESS_TOKEN']
+    super @client
+  end
+
+  def loop
+    Ripl.start binding: binding, prompt: 'MiniStrava CLI > '
+  end
+end
+
+begin
+  CLI.new.loop
+rescue MiniStrava::Client::BlankAccessTokenError
+  puts 'you must set the STRAVA_ACCESS_TOKEN env variable'
+end

data/lib/mini_strava/client.rb

@@ -0,0 +1,70 @@
+require 'uri'
+require 'net/http'
+require 'json'
+
+module MiniStrava
+  class Client
+    class AuthorizationError < Exception; end
+    class BlankAccessTokenError < Exception; end
+
+    BaseUrl = 'https://www.strava.com/api/v3'
+
+    def initialize access_token
+      raise BlankAccessTokenError.new "access_token can't be blank" if access_token.to_s.strip == ''
+      @access_token = access_token
+    end
+
+    def athlete
+      response = get '/athlete'
+      parse_response response, Models::Athlete
+    end
+
+    # valid options: before, after, page, per_page
+    def activities options={}
+      response = get '/activities', options
+      parse_response response, Models::Activity
+    end
+
+    def activity id, options={}
+      response = get "/activities/#{id}"
+      parse_response response, Models::Activity
+    end
+
+    private
+
+    def get path, params={}
+      uri = build_uri path, params
+      request = Net::HTTP::Get.new uri
+      perform_request request, uri
+    end
+
+    def perform_request request, uri
+      response = Net::HTTP.start uri.hostname, uri.port, use_ssl: true do |http|
+        http.request request
+      end
+
+      case response.code
+      when 401
+        raise AuthorizationError.new
+      else
+        response
+      end
+    end
+
+    def parse_response response, type
+      attributes = JSON.parse response.body
+      if attributes.is_a? Array
+        attributes.collect { |a| type.build a }
+      else
+        type.build attributes
+      end
+    end
+
+    def build_uri path, params={}
+      params = params.merge access_token: @access_token
+      uri = URI(File.join(BaseUrl, path))
+      uri.query = URI.encode_www_form params
+      uri
+    end
+  end
+end

data/lib/mini_strava/model.rb

@@ -0,0 +1,64 @@
+module MiniStrava
+  module Model
+    DefaultAttrType = :basic
+
+    def self.included base
+      base.send :include, InstanceMethods
+      base.extend ClassMethods
+    end
+
+    module InstanceMethods
+      def attributes
+        @attributes ||= {}
+      end
+    end
+
+    module ClassMethods
+      def build attributes
+        object = self.new
+        model_attributes.each do |attr|
+          object.send "#{attr[:name]}=", attributes[attr[:name]]
+        end
+        object
+      end
+
+      def model_attributes
+        @model_attributes ||= []
+      end
+
+      def model_attr name, type: DefaultAttrType, default: nil
+        model_attributes << {
+          name:     name.to_s,
+          type:     type,
+          default:  default
+        }
+        define_model_att_reader name
+        define_model_att_writer name, type, default
+      end
+
+      def define_model_att_reader name
+        define_method name do
+          attributes[name]
+        end
+      end
+
+      def define_model_att_writer name, type, default
+        define_method "#{name}=" do |value|
+          value = default if value.nil?
+          if type != DefaultAttrType
+            klass = Models.const_get type.to_s
+            value = if value.is_a? Array
+              value.collect do |v|
+                klass.build v || {}
+              end
+            else
+              klass.build value || {}
+            end
+          end
+
+          attributes[name] = value
+        end
+      end
+    end
+  end
+end

data/lib/mini_strava/models/activity.rb

@@ -0,0 +1,31 @@
+module MiniStrava
+  module Models
+    class Activity
+      include Model
+
+      model_attr :id
+      model_attr :resource_state
+      model_attr :external_id
+      model_attr :athlete, type: :Athlete
+      model_attr :name
+      model_attr :distance
+      model_attr :moving_time
+      model_attr :elapsed_time
+      model_attr :total_elevation_gain
+      model_attr :type
+      model_attr :start_date
+      model_attr :start_date_local
+      model_attr :timezone
+      model_attr :start_latlng
+      model_attr :end_latlng
+      model_attr :location_city
+      model_attr :location_state
+      model_attr :location_country
+      model_attr :start_latitude
+      model_attr :start_longitude
+      model_attr :average_speed
+      model_attr :max_speed
+      model_attr :segment_efforts, type: :SegmentEffort, default: []
+    end
+  end
+end

data/lib/mini_strava/models/athlete.rb

@@ -0,0 +1,23 @@
+module MiniStrava
+  module Models
+    class Athlete
+      include Model
+
+      model_attr :id
+      model_attr :firstname
+      model_attr :lastname
+      model_attr :resource_state
+      model_attr :profile_medium
+      model_attr :profile
+      model_attr :city
+      model_attr :state
+      model_attr :country
+      model_attr :sex
+      model_attr :date_preference
+      model_attr :measurement_preference
+      model_attr :email
+      model_attr :bikes, type: :Gear, default: []
+      model_attr :shoes, type: :Gear, default: []
+    end
+  end
+end

data/lib/mini_strava/models/gear.rb

@@ -0,0 +1,17 @@
+module MiniStrava
+  module Models
+    class Gear
+      include Model
+
+      model_attr :id
+      model_attr :primary
+      model_attr :name
+      model_attr :resource_state
+      model_attr :distance
+      model_attr :brand_name
+      model_attr :model_name
+      model_attr :frame_type
+      model_attr :description
+    end
+  end
+end

data/lib/mini_strava/models/segment.rb

@@ -0,0 +1,20 @@
+module MiniStrava
+  module Models
+    class Segment
+      include Model
+
+      model_attr :id
+      model_attr :resource_state
+      model_attr :name
+      model_attr :activity_type
+      model_attr :distance
+      model_attr :average_grade
+      model_attr :maximum_grade
+      model_attr :elevation_high
+      model_attr :elevation_low
+      model_attr :city
+      model_attr :state
+      model_attr :country
+    end
+  end
+end

data/lib/mini_strava/models/segment_effort.rb

@@ -0,0 +1,20 @@
+module MiniStrava
+  module Models
+    class SegmentEffort
+      include Model
+
+      model_attr :id
+      model_attr :resource_state
+      model_attr :name
+      model_attr :activity, type: :Activity
+      model_attr :athlete, type: :Athlete
+      model_attr :elapsed_time
+      model_attr :moving_time
+      model_attr :start_date
+      model_attr :start_date_local
+      model_attr :distance
+      model_attr :segment, type: :Segment
+    end
+  end
+end
+

data/lib/mini_strava/version.rb

@@ -0,0 +1,3 @@
+module MiniStrava
+  VERSION = "0.1.0"
+end

data/lib/mini_strava.rb

@@ -0,0 +1,11 @@
+require 'mini_strava/version'
+require 'mini_strava/client'
+require 'mini_strava/model'
+require 'mini_strava/models/activity'
+require 'mini_strava/models/athlete'
+require 'mini_strava/models/gear'
+require 'mini_strava/models/segment'
+require 'mini_strava/models/segment_effort'
+
+module MiniStrava
+end

data/mini_strava.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mini_strava/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mini_strava"
+  spec.version       = MiniStrava::VERSION
+  spec.authors       = ["Andrea Franz"]
+  spec.email         = ["andrea@gravityblast.com"]
+  spec.summary       = %q{A simple client for the strava API}
+  spec.description   = %q{A simple client for the strava API}
+  spec.homepage      = "https://github.com/pilu/mini-strava"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'ripl'
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

data/spec/client_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+module MiniStrava
+  describe Client do
+    subject { Client.new 'test_token' }
+
+    context '#build_uri' do
+      it 'should build uri with params' do
+        require 'pry'; binding.pry;
+        params = { foo: :bar, baz: :qux }
+        uri = subject.send(:build_uri, '/test', params)
+
+        expected = Client::BaseUrl + '/test?foo=bar&baz=qux&access_token=test_token'
+        expect(uri.to_s).to eq(expected)
+      end
+    end
+
+    context 'parse_response' do
+      it 'should parse response and return an athlete model' do
+        body = double('body')
+        parsed_body = double('parsed_body')
+        model_class = double('model_class')
+        response = double('response', body: body)
+
+        expect(JSON).to receive(:parse).with(body).and_return(parsed_body)
+        expect(model_class).to receive(:build).with(parsed_body)
+        subject.send :parse_response, response, model_class
+      end
+    end
+
+    describe '#athlete' do
+      it 'should retrieve current athlete' do
+        body = fixture 'athlete'
+        response = double('response', body: body)
+        expect(subject).to receive(:get).with('/athlete').and_return(response)
+
+        athlete = subject.athlete
+        expect(athlete.class).to eq(Models::Athlete)
+        expect(athlete.firstname).to eq('Foo')
+      end
+    end
+
+    context '#activity' do
+      it 'should retrieve activity' do
+        body = fixture 'activity'
+        response = double('response', body: body)
+        expect(subject).to receive(:get).with('/activities/10').and_return(response)
+
+        activity = subject.activity 10
+        expect(activity.class).to eq(Models::Activity)
+        expect(activity.name).to eq('Morning Commute')
+      end
+    end
+
+    context '#activities' do
+      it 'should retrieve activities' do
+        body = fixture 'activities'
+        response = double('response', body: body)
+        expect(subject).to receive(:get).with('/activities', {}).and_return(response)
+
+        activities = subject.activities
+        expect(activities.class).to eq(Array)
+        expect(activities.size).to eq(2)
+
+        expect(activities[0].class).to eq(Models::Activity)
+        expect(activities[0].id).to eq(1)
+        expect(activities[0].name).to eq('Morning Commute')
+
+        expect(activities[1].class).to eq(Models::Activity)
+        expect(activities[1].id).to eq(2)
+        expect(activities[1].name).to eq('Morning Commute 2')
+      end
+    end
+
+    context '401 Not Authorized' do
+      it 'should raise a AuthorizationError exception' do
+        response = double('response', code: 401)
+        expect(Net::HTTP).to receive(:start).and_return(response)
+        expect do
+          subject.athlete
+        end.to raise_error(Client::AuthorizationError)
+      end
+    end
+  end
+end

data/spec/fixtures/activities.json

@@ -0,0 +1,116 @@
+[
+  {
+    "id": 1,
+    "resource_state": 3,
+    "external_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
+    "athlete": {
+      "id": 101,
+      "resource_state": 1
+    },
+    "name": "Morning Commute",
+    "distance": 1850.6,
+    "moving_time": 443,
+    "elapsed_time": 443,
+    "total_elevation_gain": 12.6,
+    "type": "Ride",
+    "start_date": "2014-08-08T09:14:08Z",
+    "start_date_local": "2014-08-08T10:14:08Z",
+    "timezone": "(GMT+00:00) Europe/London",
+    "start_latlng": [50.0, -1],
+    "end_latlng": [52.0, -2],
+    "location_city": "London",
+    "location_state": "England",
+    "location_country": "United Kingdom",
+    "start_latitude": 50.0,
+    "start_longitude": -1,
+    "achievement_count": 0,
+    "comment_count": 0,
+    "athlete_count": 1,
+    "photo_count": 0,
+    "map": {
+      "id": "a177190357",
+      "polyline": "test-test-test",
+      "resource_state": 3,
+      "summary_polyline": "test"
+    },
+    "trainer": false,
+    "commute": false,
+    "manual": false,
+    "private": false,
+    "flagged": false,
+    "gear_id": "12345",
+    "average_speed": 4.177,
+    "max_speed": 13.6,
+    "average_watts": 70.7,
+    "kilojoules": 31.3,
+    "truncated": 183,
+    "has_kudoed": false,
+    "description": "",
+    "calories": 34.9,
+    "segment_efforts": [],
+    "gear": {
+      "id": "12345",
+      "primary": false,
+      "name": "Bike 1",
+      "resource_state": 2,
+      "distance": 270403.0
+    }
+  },
+  {
+    "id": 2,
+    "resource_state": 3,
+    "external_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
+    "athlete": {
+      "id": 101,
+      "resource_state": 1
+    },
+    "name": "Morning Commute 2",
+    "distance": 1850.6,
+    "moving_time": 443,
+    "elapsed_time": 443,
+    "total_elevation_gain": 12.6,
+    "type": "Ride",
+    "start_date": "2014-08-08T09:14:08Z",
+    "start_date_local": "2014-08-08T10:14:08Z",
+    "timezone": "(GMT+00:00) Europe/London",
+    "start_latlng": [50.0, -1],
+    "end_latlng": [52.0, -2],
+    "location_city": "London",
+    "location_state": "England",
+    "location_country": "United Kingdom",
+    "start_latitude": 50.0,
+    "start_longitude": -1,
+    "achievement_count": 0,
+    "comment_count": 0,
+    "athlete_count": 1,
+    "photo_count": 0,
+    "map": {
+      "id": "a177190357",
+      "polyline": "test-test-test",
+      "resource_state": 3,
+      "summary_polyline": "test"
+    },
+    "trainer": false,
+    "commute": false,
+    "manual": false,
+    "private": false,
+    "flagged": false,
+    "gear_id": "12345",
+    "average_speed": 4.177,
+    "max_speed": 13.6,
+    "average_watts": 70.7,
+    "kilojoules": 31.3,
+    "truncated": 183,
+    "has_kudoed": false,
+    "description": "",
+    "calories": 34.9,
+    "segment_efforts": [],
+    "gear": {
+      "id": "12345",
+      "primary": false,
+      "name": "Bike 1",
+      "resource_state": 2,
+      "distance": 270403.0
+    }
+  }
+]