todaysplan 0.1.0

data/README.md

@@ -0,0 +1,43 @@
+[![Build Status](https://travis-ci.org/9kSoftware/todaysplan-ruby.svg?branch=master)](https://travis-ci.org/9kSoftware/todaysplan-ruby)
+# todaysplan-ruby
+A Ruby Library for TodaysPlan
+
+This library is currently limited to only a few API calls needed.  Feel free to do
+Pull Request to include additional calls.
+
+## Installation
+
+Add the gem to your app
+
+```ruby
+gem 'todaysplan-ruby'
+```
+
+### Usage
+
+To authenticate with TodaysPlan API by setting the username and password variables
+```ruby
+TodaysPlan.username = 'email@example.com'
+TodaysPlan.password = 'secret'
+athletes = TodaysPlan::Athlete.all
+```
+or create a TodaysPlan client and pass the client to the method
+```ruby
+client = TodaysPlan::Client.new('email@example.com','secret')
+athletes = TodaysPlan::Athlete.all(client)
+```
+
+### Testing
+You can test live data by setting your credentials in todays_plan.yml.  If this file 
+exists, live connections can be made and log the response to the console.
+
+```yaml
+---
+username: 'email@example.com'
+password: 'secret'
+endpoint: 
+timeout: 120 
+logger: 'stdout'
+debug: true 
+```
+

data/Rakefile

@@ -0,0 +1,20 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/lib/todays_plan.rb

@@ -0,0 +1,47 @@
+require 'todays_plan/version'
+require 'todays_plan/client'
+require 'todays_plan/connector'
+require 'todays_plan/athlete'
+require 'todays_plan/activity'
+require 'rest_client'
+
+module TodaysPlan
+  
+  class << self
+    attr_accessor :username,
+      :password,
+      :endpoint,
+      :timeout,
+      :logger,
+      :debug
+      
+    def configure(&block)
+      raise ArgumentError, "must provide a block" unless block_given?
+      block.arity.zero? ? instance_eval(&block) : yield(self)
+    end
+    
+    # set default endpoint
+    def endpoint
+      @endpoint ||= 'https://whats.todaysplan.com.au/rest'
+    end
+    
+    #set default timeout
+    def timeout
+      @timeout ||= 120 #rest-client default
+    end
+    
+    #set default logger
+    def logger
+      if @debug
+       @logger = 'stdout'
+       return
+      end
+      @logger ||= nil
+    end
+    
+    def debug
+      @debug ||= false
+    end
+    
+  end
+end

data/lib/todays_plan/activity.rb

@@ -0,0 +1,67 @@
+module TodaysPlan
+  # Uses the TodaysPlan API for workouts and athlete information
+
+  class  Activity
+    
+    attr_reader :id
+    attr_reader :athlete_id
+    attr_reader :name
+    attr_reader :state
+    attr_reader :ts
+    attr_reader :type
+    attr_reader :completed_time
+    attr_reader :planned_time
+    attr_reader :description
+    attr_reader :completed_tscorepwr
+    attr_reader :planned_tscorepwr
+    
+    def initialize(fields)
+      @id = fields['id'].to_i
+      @athlete_id = fields['user']['id'].to_i
+      @name = fields['name']
+      @state = fields['state']
+      @ts = Time.at(fields['ts'].to_i/1000).to_i
+      @type = fields['type']
+      @completed_time = fields["training"]
+      @planned_time = fields.has_key?('scheduled') ? fields['scheduled']["durationSecs"] : nil
+      @description = fields.has_key?('scheduled')? fields['scheduled']["preDescr"] : nil
+      @completed_tscorepwr = fields["tscorepwr"]
+      @planned_tscorepwr = fields.has_key?('scheduled')? fields['scheduled']["tscorepwr"] : nil
+    end
+    
+    
+    # Find all coaches athletes workouts
+    # +payload+:: they payload to send to in json format
+    # +offset+:: record count to start out
+    # +total+:: number of records to return
+    # +client+:: the authenticated client
+    # payload example: 
+    #    {
+    #  "criteria": {
+    #    "fromTs": 1451566800000,
+    #    "toTs": 1496239200000,
+    #    "isNull": [
+    #      "fileId"
+    #    ],
+    #    "excludeWorkouts": [
+    #      "rest"
+    #    ]
+    #  },
+    #  "fields": [
+    #    "scheduled.name",
+    #    "scheduled.day",
+    #    "workout",
+    #     “state”, 
+    #     “reason”
+    #  ],
+    #  "opts": 1
+    #}
+    def self.all(payload,offset = 0, total = 100, client: nil)
+      Connector.new("/users/activities/search/#{offset}/#{total}/", client).
+        post(payload)['result']['results'].map do |data|
+        new(data)
+      end
+    end
+      
+  end
+end

data/lib/todays_plan/athlete.rb

@@ -0,0 +1,43 @@
+module TodaysPlan
+  # Uses the TodaysPlan API for workouts and athlete information
+
+  class Athlete
+    
+    attr_reader :id
+    attr_reader :name
+    attr_reader :first_name
+    attr_reader :last_name
+    attr_reader :timezone
+    attr_reader :coach
+    attr_reader :email
+    attr_reader :dob
+    
+
+    def initialize(fields)
+      @id = fields['id'].to_i
+      @name = fields['_name']
+      @first_name = fields['firstname']
+      @last_name = fields['lastname']
+      @timezone = fields['timezone']
+      @coach =  fields['coach']["id"].to_i if fields.has_key?("coach")
+      @email = fields['email']
+      @dob =  Time.at(fields['dob'].to_i/1000)
+    end
+      
+    # Find a single athlete 
+    # +client+:: the authenticated client
+    # +id+:: the athlete id
+    # +options+:: has of options
+    def self.find(id)      
+      all().find{|a| a.id==id}
+    end
+    
+    # Find all the coaches athletes 
+    # +client+:: the authenticated client
+    def self.all(client = nil)
+      Connector.new('/users/delegates/users', client).get.map do |data|
+        new(data)
+      end
+    end
+  end
+end

data/lib/todays_plan/client.rb

@@ -0,0 +1,27 @@
+module TodaysPlan
+  class Client
+
+    attr_reader :token
+
+    def initialize(username,password)
+      RestClient.log=TodaysPlan.logger
+      @token = authenticate(username,password)
+    end
+    
+    
+    def logout
+      url = TodaysPlan.endpoint+"/auth/logout"
+      response= RestClient.get(url, {:Authorization => "Bearer #{token}"})
+      response.body
+    end
+    
+    private 
+    def authenticate(username,password)
+      payload= {'username'=>username,"password"=>password, "token"=> true}
+      url = TodaysPlan.endpoint+"/auth/login"
+      response= RestClient.post(url, payload.to_json,{content_type: :json, accept: :json} )
+      body = JSON.parse(response.body)
+      body['token']
+    end
+  end
+end

data/lib/todays_plan/connector.rb

@@ -0,0 +1,39 @@
+module TodaysPlan
+  class Connector
+    attr_reader :uri, :response, :body, :timeout, :client
+
+    def initialize(path, client = nil)
+      @client = client || Client.new(TodaysPlan.username, TodaysPlan.password)
+      @uri = TodaysPlan.endpoint + path
+      @timeout = TodaysPlan.timeout
+    end
+    
+    # Internal: Run GET request.
+    #
+    # Returns the parsed JSON response body.
+    def get()
+      @response =  RestClient::Request.execute(method: :get, url: @uri, 
+        timeout: @timeout, 
+        headers: {:Authorization => "Bearer #{@client.token}",accept: :json} )
+      puts "#{@response.body}" if TodaysPlan.debug
+      @body = JSON.parse(@response.body)
+    end
+    
+    # Internal: Run GET request.
+    #
+    # Returns the parsed JSON response body.
+    def post(payload = {})
+      @response =  RestClient::Request.execute(method: :post,
+        payload: payload, url: @uri, 
+        timeout: @timeout, 
+        headers:{:Authorization => "Bearer #{@client.token}",
+          content_type: :json,
+          accept: :json})
+      puts "#{@response.body}" if TodaysPlan.debug
+      @body = JSON.parse(@response.body)
+      @body
+    end
+    
+    
+  end
+end

data/lib/todays_plan/version.rb

@@ -0,0 +1,3 @@
+module TodaysPlan
+  VERSION  = '0.1.0'
+end

data/spec/fixtures/activities/incomplete.json

@@ -0,0 +1,20 @@
+{
+    "criteria": {
+        "fromTs": 1451566800000,
+        "toTs": 1496239200000,
+        "isNull": [
+            "fileId"
+        ],
+        "excludeWorkouts": [
+            "rest"
+        ]
+    },
+    "fields": [
+        "scheduled.name",
+        "scheduled.day",
+        "workout",
+        "state",
+        "reason"
+    ],
+    "opts": 1
+}

data/spec/fixtures/activities/incomplete_response.json

@@ -0,0 +1,43 @@
+{
+  "cnt": 1.0,
+  "offset": 0.0,
+  "result": {
+    "fields": {},
+    "results": [
+      {
+        "id": 60390.0,
+        "scheduled": {
+          "name": "Efforts",
+          "day": 1
+        },
+        "source": "file",
+        "user": {
+          "id": 64.0,
+          "dob": 4.853952E11,
+          "firstname": "Joe",
+          "lastname": "Athlete",
+          "isPremium": true
+        },
+        "name": "Efforts",
+        "workoutId": 46.0,
+        "activityId": 46.0,
+        "activity": "workouts",
+        "ts": 1.4786712E12,
+        "tz": "Europe/Madrid",
+        "type": "ride",
+        "equipment": "road",
+        "workout": "training",
+        "permissions": [
+          "edit1",
+          "del",
+          "edit2",
+          "view2",
+          "view1",
+          "view3",
+          "edit3"
+        ]
+      }
+    ],
+    "keys": []
+  }
+}

data/spec/fixtures/athletes/response.json

@@ -0,0 +1,25 @@
+[{
+        "_name": "Joe Athlete",
+        "id": 7187033,
+        "email": "joeathlete@example.com",
+        "md5": "df1cc92fbe295b86fdceb070d5458e84",
+        "dob": 315532800000,
+        "_dob-display": "1/1/80",
+        "firstname": "Joe",
+        "lastname": "Athlete",
+        "timezone": "US/Mountain",
+        "relationship": "coach",
+        "_relationship-display": "Coach",
+        "isPremium": false,
+        "hasPwr": false,
+        "hasBpm": false,
+        "lastLogin": 1478439753344,
+        "_lastLogin-display": "11/6/16 6:42 AM",
+        "coach": {
+            "id": 7187033
+        },
+        "schedulePref": "prefer_single",
+        "_schedulePref-display": "Single sessions",
+        "roles": ["pi", "user"],
+        "attsMask": 514
+    }]

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'shoulda-matchers'
+require 'todays_plan'
+require 'webmock/rspec'
+
+CONFIG={}
+if File.exists?('todays_plan.yml')
+  CONFIG=YAML.load(ERB.new(File.read("todays_plan.yml")).result)
+end
+
+TodaysPlan.configure do |config|
+  config.username = CONFIG["username"] ||= 'id'
+  config.password = CONFIG["password"] ||= 'secret'
+  #config.endpoint = 'https://whats.todaysplan.com.au/rest/'
+  config.timeout = CONFIG["timeout"] ||= 120
+  config.logger = CONFIG["logger"] ||= nil
+  config.debug = CONFIG["debug"] ||= false
+end 
+
+WebMock.allow_net_connect! if TodaysPlan.debug
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.order = "random"
+  config.before {
+    stub_request(:post, TodaysPlan.endpoint+'/auth/login').
+      with(:body => "{\"username\":\"#{TodaysPlan.username}\",\"password\":\"#{TodaysPlan.password}\",\"token\":true}",
+      :headers => {'Accept'=>'application/json', 
+        'Content-Type'=>'application/json', }).
+      to_return(:status => 200, :body => '{"token":"abc-123"}', :headers => {}) unless TodaysPlan.debug
+  }
+end

data/spec/todays_plan/activity_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe TodaysPlan::Activity do
+
+
+  #let(:json){File.read("spec/fixtures/activities/incomplete.json")}
+  let(:json){'{"criteria":{"fromTs":1482735600000.0,"toTs":1486364400000.0,"userIds":[7184519]},"fields":["scheduled.name","scheduled.day","workout","state","reason"],"opts":1}'}
+  let(:response){File.read("spec/fixtures/activities/incomplete_response.json")}
+  
+  it "expect to get incomplete activites" do
+    
+    stub_request(:post, "#{TodaysPlan.endpoint}/users/activities/search/0/100/").
+      with(:body => json,
+      :headers => {'Accept'=>'application/json', 
+        'Authorization'=>'Bearer abc-123',  
+        'Content-Type'=>'application/json', }).
+      to_return(:status => 200, :body => response, :headers => {})
+    all = TodaysPlan::Activity.all(json,0,100)
+    expect(all).to be_a(Array)
+    expect(all[0]).to be_a(TodaysPlan::Activity)
+  end
+ 
+end