fitbark 0.1.1

data/lib/fitbark/data/dog_info.rb

@@ -0,0 +1,118 @@
+module Fitbark
+  module Data
+    # Defines structure for dog's informations.
+    #
+    # Original attribute names from source API:  
+    # - *slug*
+    # - *name*
+    # - *bluetooth_id*
+    # - *activity_value*
+    # - *birth*
+    # - *breed1*
+    # - *breed2*
+    # - *gender*
+    # - *weight*
+    # - *weight_unit*
+    # - *country*
+    # - *zip*
+    # - *tzoffset*
+    # - *tzname*
+    # - *min_play*
+    # - *min_active*
+    # - *min_rest*
+    # - *medical_conditions*
+    # - *hourly_average*
+    # - *picture_hash*
+    # - *neutered*
+    # - *last_min_time*
+    # - *last_min_activity*
+    # - *daily_goal*
+    # - *battery_level*
+    # - *last_sync*
+    class DogInfo < StrictOpenStruct
+      include Fitbark::Data::Shared
+
+      # parse source String value into Date for *birth* attribute
+      def birth
+        date_parser(self[:birth])
+      end
+
+      alias birth_on birth
+
+      # an alias for source *gender* attribute
+      def sex
+        self[:gender]
+      end
+
+      # an alias for *zip* attribute
+      def postal_code
+        self[:zip]
+      end
+
+      # an alias for *zip* attribute
+      def zip_code
+        self[:zip]
+      end
+
+      # an alias for *min_play* attribute
+      def today_minutes_playing
+        self[:min_play]
+      end
+
+      # an alias for *min_active* attribute
+      def today_minutes_active
+        self[:min_active]
+      end
+
+      # an alias for *min_rest* attribute
+      def today_minutes_resting
+        self[:min_rest]
+      end
+
+      # parse String value into Time for *last_min_time* attribute
+      def last_min_time
+        time_parser(self[:last_min_time])
+      end
+
+      alias last_minute_at last_min_time
+
+      # parse String value into Time for *last_min_activity* attribute
+      def last_minute_activity
+        self[:last_min_activity]
+      end
+
+      # an alias for *activity_value* attribute
+      def today_activity_points
+        self[:activity_value]
+      end
+
+      # parse String value into Time for *last_sync* attribute
+      def last_sync
+        time_parser(self[:last_sync])
+      end
+
+      alias sync_at last_sync
+
+      # first breed according to Fitbark::Data::Breed
+      def breed1
+        init_breed(self[:breed1])
+      end
+
+      alias first_breed breed1
+
+      # second breed according to Fitbark::Data::Breed
+      def breed2
+        init_breed(self[:breed2])
+      end
+
+      alias second_breed breed2
+
+      # an array of Fitbark::Data::MedicalCondition objects
+      def medical_conditions
+        self[:medical_conditions].map do |mc|
+          init_medical_condition(mc)
+        end
+      end
+    end
+  end
+end

data/lib/fitbark/data/dog_relation.rb

@@ -0,0 +1,27 @@
+module Fitbark
+  module Data
+    # Defines structure for dog relation between user.
+    #
+    # Original attribute names from source API: 
+    # - *id*
+    # - *date*
+    # - *dog_slug*  
+    # - *status*  
+    # - *user*
+    class DogRelation < StrictOpenStruct
+      include Fitbark::Data::Shared
+
+      # user as object kind Fitbark::Data::UserPreview
+      def user
+        Fitbark::Data::UserPreview.new(self[:user])
+      end
+
+      # parse source String value into Date for *date* attribute
+      def date
+        date_parser(self[:date])
+      end
+
+      alias related_on date
+    end
+  end
+end

data/lib/fitbark/data/medical_condition.rb

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

data/lib/fitbark/data/picture.rb

@@ -0,0 +1,21 @@
+module Fitbark
+  module Data
+    # Defines structure for picture data.
+    #
+    # Original attribute names from source API: 
+    # - *data*
+    class Picture < StrictOpenStruct
+      include Fitbark::Data::Shared
+
+      # an alias for *data* attribute
+      def base64
+        self[:data]
+      end
+
+      # decode data from base64
+      def bytes
+        Base64.decode64(data)
+      end
+    end
+  end
+end

data/lib/fitbark/data/shared.rb

@@ -0,0 +1,36 @@
+module Fitbark
+  module Data
+    # Provides general behaviour for data classes.
+    module Shared
+      # :nodoc:
+      def self.included(base)
+        base.send :extend, ClassMethods
+      end
+
+      module ClassMethods
+      end
+
+      private
+      
+      def time_parser(attr)
+        Time.parse(attr.to_s)
+      rescue ArgumentError
+        nil
+      end
+
+      def date_parser(attr)
+        Date.parse(attr.to_s)
+      rescue ArgumentError
+        nil
+      end
+
+      def init_breed(attr)
+        Fitbark::Data::Breed.new(attr)
+      end
+
+      def init_medical_condition(attr)
+        Fitbark::Data::MedicalCondition.new(attr)
+      end
+    end
+  end
+end

data/lib/fitbark/data/similar_dogs_stat.rb

@@ -0,0 +1,22 @@
+module Fitbark
+  module Data
+    # Defines structure for similar dogs stats.
+    #
+    # Original attribute names from source API: 
+
+    # - *this_best_daily_activity*
+    # - *this_best_week_activity*
+    # - *this_current_goals_streak*
+    # - *this_best_goals_streak*
+    # - *this_average_daily_activity*
+    # - *median_same_age_weight_daily_activity*
+    # - *this_average_daily_rest_minutes*
+    # - *median_same_age_weight_range_dogs_daily_rest_minutes*
+    # - *median_all_dogs_daily_activity*
+    # - *median_same_breed_daily_activity*
+    class SimilarDogsStat < StrictOpenStruct
+      include Fitbark::Data::Shared
+
+    end
+  end
+end

data/lib/fitbark/data/token.rb

@@ -0,0 +1,35 @@
+module Fitbark
+  module Data
+    # Defines structure for access token.
+    #
+    # Original attribute names from source API: 
+
+    # - *access_token*
+    # - *token_type*
+    # - *expires_in*
+    # - *scope*
+    class Token < StrictOpenStruct
+      include Fitbark::Data::Shared
+
+      # an alias for *access_token* source attribute
+      def token
+        self[:access_token]
+      end
+
+      # an alias for *token_type* source attribute
+      def type
+        self[:token_type]
+      end
+
+      # return Time of expiring based on *expires_in* source attribute
+      def expires_at
+        Time.now.utc + self[:expires_in].to_i
+      end
+
+      # return token's scopes as Array
+      def scopes
+        Array(self[:scope])
+      end
+    end
+  end
+end

data/lib/fitbark/data/token_info.rb

@@ -0,0 +1,29 @@
+module Fitbark
+  module Data
+    # Defines structure for access token informations.
+    #
+    # Original attribute names from source API: 
+
+    # - *resource_owner_id*
+    # - *scopes*
+    # - *expires_in_seconds*
+    # - *application*
+    class TokenInfo < StrictOpenStruct
+      include Fitbark::Data::Shared
+
+      # Defines structure for Application data inside TokenInfo
+      class Application < StrictOpenStruct
+        include Fitbark::Data::Shared
+      end
+
+      # return Time of expiring based on *expires_in_seconds* source attribute
+      def expires_at
+        Time.now.utc + self[:expires_in_seconds].to_i
+      end
+      # application as object kind Fitbark::Data::TokenInfo::Application
+      def application
+        Application.new self[:application]
+      end
+    end
+  end
+end

data/lib/fitbark/data/user_info.rb

@@ -0,0 +1,27 @@
+module Fitbark
+  module Data
+    # Defines structure for user's informations.
+    #
+    # Original attribute names from source API:  
+    # - *slug*
+    # - *slug*
+    # - *username*
+    # - *name*
+    # - *first_name*
+    # - *last_name*
+    # - *picture_hash*
+    class UserInfo < StrictOpenStruct
+      include Fitbark::Data::Shared
+
+      # an alias for source *username* attribute
+      def email
+        self[:username]
+      end
+
+      # an alias for source *name* attribute
+      def fullname
+        self[:name]
+      end
+    end
+  end
+end

data/lib/fitbark/data/user_preview.rb

@@ -0,0 +1,25 @@
+module Fitbark
+  module Data
+    # Defines structure for dog relation between user.
+    #
+    # Original attribute names from source API: 
+    # - *slug*  
+    # - *username*  
+    # - *name*  
+    # - *first_name*  
+    # - *last_name*   
+    class UserPreview < StrictOpenStruct
+      include Fitbark::Data::Shared
+
+      # an alias for source *username* attribute
+      def email
+        self[:username]
+      end
+
+      # an alias for source *name* attribute
+      def fullname
+        self[:name]
+      end
+    end
+  end
+end

data/lib/fitbark/data/user_relation.rb

@@ -0,0 +1,26 @@
+module Fitbark
+  module Data
+    # Defines structure for user relation between a dog.
+    #
+    # Original attribute names from source API: 
+    # - *id*
+    # - *date*
+    # - *status*  
+    # - *dog* 
+    class UserRelation < StrictOpenStruct
+      include Fitbark::Data::Shared
+
+      # dog as object kind Fitbark::Data::DogInfo
+      def dog
+        Fitbark::Data::DogInfo.new(self[:dog])
+      end
+
+      # parse source String value into Date for *date* attribute
+      def date
+        date_parser(self[:date])
+      end
+
+      alias related_on date
+    end
+  end
+end

data/lib/fitbark/errors.rb

@@ -0,0 +1,33 @@
+module Fitbark
+  # Provides namespace for error classes.
+  module Errors
+    # provide base behaviour for all errors classes.
+    class BaseError < StandardError
+      def initialize(message: nil, code: 400)
+        @message = message
+        @code = code
+      end
+
+      attr_accessor :message, :code
+
+      def to_s
+        "#{code} - #{message}"
+      end
+    end
+
+    # FetchTokenError
+    class FetchTokenError < BaseError; end
+    # TokenNotProvidedError
+    class TokenNotProvidedError < BaseError
+      def initialize
+        @message = 'Token is required for this operation'
+      end
+    end
+    # ConnectionError
+    class ConnectionError < BaseError; end
+    # DataError
+    class DataError < BaseError; end
+    # FormatError
+    class FormatError < BaseError; end
+  end
+end

data/lib/fitbark/handler/v2/activity_series.rb

@@ -0,0 +1,90 @@
+module Fitbark
+  module Handler
+    module V2
+      # = \#activity_series
+      # Fitbark::Handler::V2::ActivitySeries define method *activity_series*
+      # inside Client object
+      #
+      # === params (key/value):
+      #
+      # - *dog_slug*: slug ID relative to dog (String)
+      # - *from*: data start date (Date)
+      # - *to*: data end date (Date)
+      # - *resolution*: can be +:daily+ or +:hourly+ (Symbol)
+      #
+      # example usage:
+      #   client = Client.new(token: 'a5b3f8...')
+      #   client.activity_series(dog_slug: 'v4s1...', from: 3.days.ago, to: Date.today, resolution: :daily)
+      #
+      # === response:
+      # when resolution is +:daily+:: An array of
+      #                               Fitbark::Data::ActivityDaily objects.
+      # when resolution is +:hourly+:: An array of
+      #                                Fitbark::Data::ActivityHourly objects.
+      class ActivitySeries
+        include Fitbark::Handler::V2::Base
+
+        # :nodoc:
+        RESOLUTIONS = %i[daily hourly].freeze
+
+        def initialize(token:, opts: {})
+          super
+          @resolution = opts.fetch(:resolution, '').to_s.downcase.to_sym
+          validate_input
+        end
+
+        attr_reader :resolution
+
+        # https://app.fitbark.com/api/v2/activity_series
+        def response
+          json_response.dig('activity_series', 'records').map do |as|
+            data_class.new(as)
+          end
+        end
+
+        private
+
+        def raw_response
+          connection(verb: :post, fragment: 'activity_series',
+                     params: build_params(opts[:dog_slug], opts[:from],
+                                          opts[:to], resolution)).body
+        end
+
+        def build_params(slug, from, to, res)
+          {
+            "activity_series": {
+              "slug": slug,
+              "from": from,
+              "to": to,
+              "resolution": format_resolution(res)
+            }
+          }
+        end
+
+        def format_resolution(val)
+          val.to_s.upcase
+        end
+
+        def validate_input
+          unless RESOLUTIONS.include? resolution
+            raise(Fitbark::Errors::FormatError
+              .new(message: "Wrong or missing param 'resolution', must be kind of:
+               #{Fitbark::Handler::V2::ActivitySeries::RESOLUTIONS.join(', ')}"))
+          end
+          unless opts[:from].instance_of?(Date)
+            raise Fitbark::Errors::FormatError
+              .new(message: "Wrong or missing date for param 'from'")
+          end
+          unless opts[:to].instance_of?(Date)
+            raise Fitbark::Errors::FormatError
+              .new(message: "Wrong or missing date for param 'to'")
+          end
+        end
+
+        def data_class
+          eval("Fitbark::Data::Activity#{camel(resolution.to_s)}")
+        end
+      end
+    end
+  end
+end