fitbark 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9c27e175fffa5ad6d65dcf672027dcb981b6c56b187dc1f57fdc9f94e1cacc6d
+  data.tar.gz: e066e82e6c6cf061afc7f5f6b7b4645da02d20ba6cd2d8d08c890e25b612080f
+SHA512:
+  metadata.gz: b63b828c17389cca5dd6bdd5da47f9a641eba5ba74827a2d66602a6f29ede945b7135ac0e9dbf9fd6df425d55e559a34a464a807c7c282be16b6ef0d6b14fe57
+  data.tar.gz: f6ec931813547be2a4cb8d192f6fce8b408af1071e99e80aee2615de9dc3947a5cec28c43d852b836f1476d1a40d125e817bb3b6606e77bce81c98836457ec42

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Metrics/BlockLength:
+  Max: 50
+  Exclude:
+    - 'fitbark.gemspec'
+    - 'lib/**/*.rb'
+    - 'spec/**/*.rb'

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at natydev@localhost. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    fitbark (0.1.0)
+      addressable (~> 2.6)
+      faraday (~> 0.15)
+      oj (~> 3.7)
+      strict_open_struct (~> 0.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    concurrent-ruby (1.1.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    faker (1.9.3)
+      i18n (>= 0.7)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (0.3.8)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.2)
+    multipart-post (2.0.0)
+    oj (3.7.12)
+    parallel (1.17.0)
+    parser (2.6.2.1)
+      ast (~> 2.4.0)
+    psych (3.1.0)
+    public_suffix (3.0.3)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.67.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.10.0)
+    safe_yaml (1.0.5)
+    strict_open_struct (0.0.2.0)
+    unicode-display_width (1.5.0)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  faker (~> 1.9)
+  fitbark!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.63)
+  webmock (~> 3.5)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 NatyDev
+
+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,194 @@
+![](https://inch-ci.org/github/natydev/fitbark.svg?branch=master&style=flat)
+[![Build Status](https://travis-ci.org/natydev/fitbark.png?branch=master)](https://travis-ci.org/natydev/fitbark)
+[![Maintainability](https://api.codeclimate.com/v1/badges/20bcd9a6380363916f5e/maintainability)](https://codeclimate.com/github/natydev/fitbark/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/20bcd9a6380363916f5e/test_coverage)](https://codeclimate.com/github/natydev/fitbark/test_coverage)
+[![Gem Version](https://badge.fury.io/rb/fitbark.svg)](https://badge.fury.io/rb/fitbark)
+
+
+# FitBark
+
+A Ruby interface to the FitBark® API.
+
+* website: [https://www.fitbark.com](https://www.fitbark.com)
+* API documentation: [https://www.fitbark.com/dev/](https://www.fitbark.com/dev/)
+
+Using this **gem** you will **benefit** from the following **advantages** over the FitBark's source API (which unfortunately does not fully follow the REST good practices):
+
+* Consistency in the nomenclature (ex: collections named as plural, single objects as singular, standardized key params in different methods/calls).
+* Items as real specific objects.
+* Attribute value received according to the right type (`String`, `Integer`, `Time`, `Date` ...).
+* Attibutes aliases with ruby-friendly nomenclature (ex: `*_at` for time values, `*_on` for dates, `*?` for predicates, etc.)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fitbark'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fitbark
+
+
+## Usage examples
+
+First of all, to use this gem you need to register inside FitBark's website for a FitBark Developer Application.
+
+Once you have the `client_id` and `client_secret` you can start to use FitBark's API.
+
+### Authentication
+
+First step: in Terminal open `irb` or rails `console`, then generate an **authorization uri**:
+
+```ruby
+  require 'fitbark'
+  
+  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
+```
+Second step: open/redirect your browser to authorization uri, a prompt for a **user login** will appear, once the login is done an **authorization code** can be fetched from success redirection (in the uri or html).
+
+Third step: retieve **access token**:
+
+```ruby
+  authorization_code = '27e5dd1307cddc7b5d8d72264ef1...'
+  
+  auth = Fitbark::Auth.new(client_id: client_id, redirect_uri: redirect_uri,  
+         code: authorization_code, client_secret: client_secret)
+  data_token = auth.fetch_access_token!
+```
+
+#### Fitbark::Auth #fetch\_access\_token!
+
+Returns an object kind `Fitbark::Data::Token` having this properties:
+
+  - **token**: the access token string.
+  - **type**: access token's typology.
+  - **expires_at**: a time based on the expires_in attribute.
+  - **scopes**: an array of scopes
+
+### Interface
+
+With `Fitbark::Client` we interact with API endpoints calling the specific methods.  
+To use a client it must be initialized with a token:
+
+```ruby
+  client = Fitbark::Client.new(token: data_token.token)
+```
+
+logged user informations:
+
+```ruby
+  user = client.user_info
+  # returns an object Fitbark::Data::UserInfo
+```
+
+user's picture:
+
+```ruby
+  client.user_picture(user_slug: user.slug)
+  # returns an object Fitbark::Data::PictureInfo
+```
+
+all dogs owned by logged user:
+
+```ruby
+  client.own_dogs
+  # returns an array of Fitbark::Data::DogInfo
+```
+
+all dogs having friendship with logged user:
+
+```ruby
+  client.friend_dogs
+  # returns an array of Fitbark::Data::DogInfo
+```
+
+choice a dog from my owned dogs:
+
+```ruby
+  my_dog = client.own_dogs.first
+  # returns an object Fitbark::Data::DogInfo
+```
+
+retrieve a dog's picture:
+
+```ruby
+  client.dog_picture(dog_slug: my_dog.slug)
+  # returns an object Fitbark::Data::PictureInfo
+```
+
+retrieve daily activity series (in a selected date range):
+
+```ruby
+client.activity_series(dog_slug: my_dog.slug,  
+ from: 7.days.ago, to: Date.today, resolution: :daily)
+ # returns an array of Fitbark::Data::ActivityDaily
+```
+
+hourly activity series (in a selected date range):
+
+```ruby
+client.activity_series(dog_slug: my_dog.slug,  
+ from: 3.days.ago, to: Date.today, resolution: :hourly)
+ # returns an array of Fitbark::Data::ActivityHourly
+```
+
+total activity points (in a selected date range):
+
+```ruby
+client.activity_total(dog_slug: my_dog.slug, from: 20.days.ago, to: Date.today)
+# returns an Integer
+```
+
+statistics about similar dogs:
+
+```ruby
+client.similar_dogs_stats(dog_slug: my_dog.slug)
+# returns a Fitbark::Data::SimilarDogsStat object
+```
+
+time breakdown:
+
+```ruby
+client.time_breakdown(dog_slug: my_dog.slug, from: 20.days.ago, to: Date.today)
+# returns a Fitbark::Data::ActivityLevel object
+```
+
+For complete documentation about all client's methods and all attributes for returned data objects please read the following section.
+
+
+## Documentation
+
+If you clone this repository in your local machine, complete documentation abount all classes and modules can be make in terminal with the command **rdoc** (from project's root directory).
+
+    $ rdoc
+
+
+## Tests
+
+Run tests with **rspec** (from project's root directory) in Terminal:
+
+    $ bundle exec rspec
+
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/natydev/fitbark. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'fitbark'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)