fitbark 0.1.1

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fitbark.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fitbark/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fitbark'
+  spec.version       = Fitbark::VERSION
+  spec.authors       = ['NatyDev']
+  spec.email         = ['natydev@aol.com']
+
+  spec.summary       = 'Wrapper for FitBark API.'
+  spec.description   = 'Wrapper for FitBark API: It provides simple methods to handle ' \
+   'authorization and to execute HTTP calls.'
+  spec.homepage      = 'https://github.com/natydev/fitbark'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0")
+                     .reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'faker', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.63'
+  spec.add_development_dependency 'webmock', '~> 3.5'
+  spec.add_dependency 'addressable', '~> 2.6'
+  spec.add_dependency 'faraday', '~> 0.15'
+  spec.add_dependency 'oj', '~> 3.7'
+  spec.add_dependency 'strict_open_struct', '~> 0.0.2'
+end

data/lib/fitbark.rb

@@ -0,0 +1,45 @@
+require 'addressable'
+require 'faraday'
+require 'oj'
+require 'base64'
+require 'strict_open_struct'
+
+require_relative 'fitbark/version'
+require_relative 'fitbark/constants'
+require_relative 'fitbark/errors'
+require_relative 'fitbark/auth'
+require_relative 'fitbark/client'
+require_relative 'fitbark/data/shared'
+require_relative 'fitbark/data/token'
+require_relative 'fitbark/data/token_info'
+require_relative 'fitbark/data/user_info'
+require_relative 'fitbark/data/picture'
+require_relative 'fitbark/data/breed'
+require_relative 'fitbark/data/medical_condition'
+require_relative 'fitbark/data/dog_info'
+require_relative 'fitbark/data/user_relation'
+require_relative 'fitbark/data/dog_relation'
+require_relative 'fitbark/data/activity_daily'
+require_relative 'fitbark/data/activity_hourly'
+require_relative 'fitbark/data/similar_dogs_stat'
+require_relative 'fitbark/data/activity_level'
+require_relative 'fitbark/data/daily_goal'
+require_relative 'fitbark/handler/v2/base'
+require_relative 'fitbark/handler/v2/user_info'
+require_relative 'fitbark/handler/v2/user_picture'
+require_relative 'fitbark/handler/v2/dog_relations'
+require_relative 'fitbark/handler/v2/dog_info'
+require_relative 'fitbark/handler/v2/dog_picture'
+require_relative 'fitbark/handler/v2/user_relations'
+require_relative 'fitbark/handler/v2/activity_series'
+require_relative 'fitbark/handler/v2/similar_dogs_stats'
+require_relative 'fitbark/handler/v2/activity_total'
+require_relative 'fitbark/handler/v2/time_breakdown'
+require_relative 'fitbark/handler/v2/daily_goals'
+require_relative 'fitbark/handler/v2/set_daily_goal'
+require_relative 'fitbark/handler/v2/own_dogs'
+require_relative 'fitbark/handler/v2/friend_dogs'
+
+module Fitbark
+  # :nodoc:
+end

data/lib/fitbark/auth.rb

@@ -0,0 +1,125 @@
+module Fitbark
+  # Provides oauth2 methods
+  class Auth
+    include Fitbark::Constants
+    # == A sample usage:
+    # First step to generate an authorization uri:
+    #     client_id = 'CLIENT-ID-PROVIDED-BY-FITBARK'
+    #     client_secret = 'CLIENT-SECRET-PROVIDED-BY-FITBARK'
+    #     redirect_uri = 'urn:ietf:wg:oauth:2.0:oob'
+    #     auth = Fitbark::Auth.new(client_id: client_id, redirect_uri: redirect_uri)
+    #     auth.authorization_uri
+    # 
+    # Once that authorization uri was open and fetched the authorization 
+    # code from html (normally this operation is done with browser),
+    # proceed with 2nd step to retieve access token:
+    #   authorization_code = '27e5dd1307cddc7b5d8d72264ef1...'
+    #   auth = Fitbark::Auth.new(client_id: client_id, redirect_uri: redirect_uri,
+    #                              code: authorization_code, client_secret: client_secret)
+    #   auth.fetch_access_token!
+    def initialize(client_id: nil, client_secret: nil,
+                   redirect_uri: nil, code: nil, token: nil)
+      @client_id = client_id
+      @client_secret = client_secret
+      @redirect_uri = redirect_uri
+      @code = code
+      @token = read_token(token)
+      @uri = Addressable::URI.new(host: API_HOST, scheme: API_SCHEME)
+    end
+
+    attr_accessor :code
+    attr_writer :token
+    attr_reader :client_id, :client_secret, :redirect_uri,
+                :token_data, :token_info
+
+    # return an URI to fetch the authorization code
+    def authorization_uri
+      uri.path = AUTHORIZE_PATH
+      uri.query_values = {
+        response_type: :code,
+        client_id: client_id,
+        redirect_uri: redirect_uri
+      }
+      uri.to_s
+    end
+
+    # return a Fitbark::Data::Token object
+    def fetch_access_token!
+      if token_response.success?
+        apply_token_data(token_response)
+      else
+        token_error(token_response)
+      end
+    end
+
+    # return a Fitbark::Data::TokenInfo object
+    def fetch_token_info
+      response = token_info_response
+      if response.success?
+        apply_token_info(response)
+      else
+        token_error(response)
+      end
+    end
+
+    # return the raw access_token (String)
+    def token
+      read_token
+    end
+
+    private
+
+    attr_accessor :uri
+
+    def token_response
+      @token_response ||= Faraday.new(url: uri.site).post do |req|
+        req.url TOKEN_PATH
+        req.body = request_token_body
+      end
+    end
+
+    def request_token_body
+      {
+        client_id: client_id,
+        client_secret: client_secret,
+        grant_type: :authorization_code,
+        redirect_uri: redirect_uri,
+        code: code
+      }
+    end
+
+    def token_info_response
+      raise Fitbark::Errors::TokenNotProvidedError if token.nil?
+
+      Faraday.new(url: uri.site).get do |req|
+        req.url TOKEN_INFO_PATH
+        req.headers = {
+          'Content-Type' => 'application/json',
+          'Authorization' => "Bearer #{token}"
+        }
+      end
+    end
+
+    def apply_token_data(resp)
+      @token_data = Fitbark::Data::Token.new(parsed_body(resp))
+    end
+
+    def apply_token_info(resp)
+      @token_info = Fitbark::Data::TokenInfo.new(parsed_body(resp))
+    end
+
+    def token_error(resp)
+      raise(Fitbark::Errors::FetchTokenError
+        .new(code: resp.status, message:
+        parsed_body(resp)['error_description']))
+    end
+
+    def read_token(val = @token)
+      (token_data.respond_to?(:token) && token_data.token) || val
+    end
+
+    def parsed_body(resp)
+      Oj.load(resp.body)
+    end
+  end
+end

data/lib/fitbark/client.rb

@@ -0,0 +1,54 @@
+module Fitbark
+  # Provides all methods to connect to the API
+  # endpoints and retrieve data 
+  class Client
+    include Fitbark::Constants
+
+    # === params (key/value):
+    #
+    # - *token*: access token retrieved from Fitbark::Auth
+    #
+    # alla available API methods inside
+    # this calss are dynamical defined by all Fitbark::Handler::V2 classes
+    # please read specific documentation for each of them
+    # == Sample usage:
+    #
+    #   token = "9083a4b0d701542c9b..."
+    #   client = Fitbark::Client.new(token: token)
+    #   user = client.user_info
+    #   first_dog = client.dog_relations.first.dog
+    #   client.dog_picture(dog_slug: first_dog.slug)
+
+    def initialize(token:)
+      raise Fitbark::Errors::TokenNotProvidedError if token.nil?
+
+      @token = token
+    end
+
+    attr_reader :uri
+
+    # :nodoc:
+    def method_missing(method, **args)
+      if respond_to?(method)
+        klass_handler(method).new(token: token, opts: args).response
+      else
+        super
+      end
+    end
+
+    # :nodoc:
+    def respond_to?(method, include_private = false)
+      return true if klass_handler(method)
+    rescue NameError => e
+      super
+    end
+
+    private
+
+    def klass_handler(handler)
+      eval("#{PREFIX_NAME_HANDLER}#{camel(handler.to_s)}")
+    end
+
+    attr_reader :token
+  end
+end

data/lib/fitbark/constants.rb

@@ -0,0 +1,17 @@
+module Fitbark
+  # Provides general constants support.
+  module Constants
+    API_SCHEME = 'https'.freeze
+    API_HOST = 'app.fitbark.com'.freeze
+    API_SUBHOST = 'api/v2'.freeze
+    AUTHORIZE_PATH = '/oauth/authorize'.freeze
+    TOKEN_PATH = '/oauth/token'.freeze
+    TOKEN_INFO_PATH = TOKEN_PATH + '/info'.freeze
+    PREFIX_NAME_HANDLER = 'Fitbark::Handler::V2::'.freeze
+
+    # :nodoc:
+    def camel(str)
+      str.split('_').collect(&:capitalize).join
+    end
+  end
+end

data/lib/fitbark/data/activity_daily.rb

@@ -0,0 +1,52 @@
+module Fitbark
+  module Data
+    # Defines structure for dog's daily activity data.
+    #
+    # Original attribute names from source API: 
+    # - *date*
+    # - *activity_value*
+    # - *activity_average*, 
+    # - *min_play*,
+    # - *min_active*
+    # - *min_rest*
+    # - *daily_target*
+    # - *has_trophy*
+    class ActivityDaily < StrictOpenStruct
+      include Fitbark::Data::Shared
+
+      # parse source String value into Date for *date* attribute
+      def date
+        date_parser(self[:date])
+      end
+
+      alias detected_on date
+
+      # an alias for *min_play* attribute
+      def minutes_playing
+        self[:min_play]
+      end
+
+      # an alias for *min_active* attribute
+      def minutes_active
+        self[:min_active]
+      end
+
+      # an alias for *min_rest* attribute
+      def minutes_resting
+        self[:min_rest]
+      end
+
+      # an alias for *daily_target* attribute
+      def daily_goal
+        self[:daily_target]
+      end
+
+      # a predicate alias for *has_trophy* attribute
+      def trophy?
+        !self[:has_trophy].zero?
+      end
+
+      alias daily_goal_reached? trophy?
+    end
+  end
+end

data/lib/fitbark/data/activity_hourly.rb

@@ -0,0 +1,46 @@
+module Fitbark
+  module Data
+    # Defines structure for dog's hourly activity data.
+    #
+    # Original attribute names from source API: 
+    # - *date*
+    # - *activity_value*
+    # - *min_play*,
+    # - *min_active*
+    # - *min_rest*
+    # - *distance_in_miles*
+    # - *kcalories*
+    # - *activity_goal*
+    class ActivityHourly < StrictOpenStruct
+      include Fitbark::Data::Shared
+
+      # parse String value into Time for *date* attribute
+      def date
+        time_parser(self[:date])
+      end
+
+      alias detected_at date
+
+      # an alias for *min_play* attribute
+      def minutes_playing
+        self[:min_play]
+      end
+
+      # an alias for *min_active* attribute
+      def minutes_active
+        self[:min_active]
+      end
+
+      # an alias for *min_rest* attribute
+      def minutes_resting
+        self[:min_rest]
+      end
+
+      # convert in kilometers from *distance_in_miles* attribute
+      def distance_in_kms
+        (self[:distance_in_miles].to_f * 1.60934).round(3)
+      end
+
+    end
+  end
+end

data/lib/fitbark/data/activity_level.rb

@@ -0,0 +1,28 @@
+module Fitbark
+  module Data
+    # Defines structure for dog's activity data.
+    #
+    # Original attribute names from source API:  
+    # - *min_play*,
+    # - *min_active*
+    # - *min_rest*
+    class ActivityLevel < StrictOpenStruct
+      include Fitbark::Data::Shared
+
+      # an alias for *min_play* attribute
+      def minutes_playing
+        self[:min_play]
+      end
+
+      # an alias for *min_active* attribute
+      def minutes_active
+        self[:min_active]
+      end
+
+      # an alias for *min_rest* attribute
+      def minutes_resting
+        self[:min_rest]
+      end
+    end
+  end
+end

data/lib/fitbark/data/breed.rb

@@ -0,0 +1,12 @@
+module Fitbark
+  module Data
+    # Defines structure for dog's breed data.
+    #
+    # Original attribute names from source API:  
+    # - *id*,
+    # - *name*
+    class Breed < StrictOpenStruct
+      include Fitbark::Data::Shared
+    end
+  end
+end

data/lib/fitbark/data/daily_goal.rb

@@ -0,0 +1,25 @@
+module Fitbark
+  module Data
+    # Defines structure for dog's daily points goal.
+    #
+    # Original attribute names from source API:  
+    # - *goal*,
+    # - *date*
+    class DailyGoal < StrictOpenStruct
+      include Fitbark::Data::Shared
+
+      # parse String value into Date for *date* attribute
+      def date
+        date_parser(self[:date])
+      end
+
+      alias set_on date
+
+      # an alias for *goal* attribute
+      def goal_points
+        self[:goal]
+      end
+
+    end
+  end
+end