exist 0.1.0.beta.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0a390bedc2fee545f9ccfded35addeaa8428dcd
+  data.tar.gz: 6dcc85f44ae9ff30d6f41049da25243b63d0c85a
+SHA512:
+  metadata.gz: d3c73b601bb3ed444f6517d14cfbbf2a294302ef15c8bce42e8aac15a63c2bd7aca42309037af5d83716101a2b6306b9bb7b8f23104d14d98fbd2e602014f955
+  data.tar.gz: c164b00cdc918ca9fa03689f72a809d01305d170c9f21d7c62d5dcaf409aba61496fca448ac35db07d43b6319a89c3d851c9ce22c149ed74b60f8115804c1fa2

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.md
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,5 @@
+Gemfile.lock
+doc/
+pkg/
+vendor/cache/*.gem
+coverage/

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "exist Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.0 / 2015-06-24
+
+* Initial release:
+

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'kramdown'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Adrian Perez
+
+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,84 @@
+# Exist.IO API Ruby Client
+
+[![Gem Version](https://badge.fury.io/rb/exist.png)](http://badge.fury.io/rb/exist) [![Build Status](https://travis-ci.org/blackxored/exist.png)](https://travis-ci.org/blackxored/exist) [![Coverage Status](https://coveralls.io/repos/blackxored/exist/badge.png?branch=master)](https://coveralls.io/r/blackxored/exist) [![Dependency Status](https://gemnasium.com/blackxored/exist.png)](https://gemnasium.com/blackxored/exist) [![Code Climate](https://codeclimate.com/github/blackxored/exist.png)](https://codeclimate.com/github/blackxored/exist)
+
+## Disclaimer
+
+Please notice that the Exist.IO API is experimental as noticed by their
+developers, so it's this library by extension, I'm not affiliated with the Exist
+development team, I'm just another user of the platform addicted to the
+quantified-self concept ;)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'exist'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install exist
+
+## Usage
+
+### Authentication
+
+All (if not most) requests require authentication. Exist uses a non-expiring
+token that you can configure this client with. It also supports username
+and password login, although I'd recommend not to store this and use
+the token instead.
+
+You can login with username & password:
+
+```ruby
+
+exist = Exist::API.new(username: 'youruser', password: 'yourpass')
+```
+
+Then retrieve the token:
+
+```ruby
+exist.api_key
+```
+
+You can store it somewhere safe, it will try to read from the `EXIST_API_TOKEN`
+environment variable if you initialize the client without options. You can also
+pass it directly, as you would have expected:
+
+```ruby
+Exist::API.new(token: "<YOUR_TOKEN>")
+```
+
+### Data methods
+
+From then on, you have access to all of the current endpoints (more
+information in the [developer's site](http://developer.exist.io/)),
+through the client instance:
+
+* The current user (`#me`).
+* Overviews (i.e. Today view) (`#overview`).
+* Attributes (`#attributes`, `#attribute`).
+* Insights (`#insights`, `#insights_for_attribute`).
+* Averages (`#averages`, `#averages_for_attribute`).
+* Correlations (`#correlations`).
+
+Notice that most endpoints can only be used with the current user,
+hence they don't ask for username, I will update this in the future 
+if this changes.
+
+## Roadmap
+
+I intent to make this gem more AR-friendly, with finders, queries, deep search,
+to fill the gaps from the API itself.
+
+## Contributing
+
+1. Fork it ( https://github.com/blackxored/exist/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit -1
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :test    => :spec
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new  
+task :doc => :yard

data/exist.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/exist/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "exist"
+  gem.version       = Exist::VERSION
+  gem.summary       = "Ruby client for the Exist.IO API"
+  gem.description   = %q{Ruby client for the Exist.IO life-tracking/correlation platform API}
+  gem.license       = "MIT"
+  gem.authors       = ["Adrian Perez"]
+  gem.email         = "adrianperez.deb@gmail.com"
+  gem.homepage      = "https://github.com/blackxored/exist"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'faraday', '~> 0.9'
+  gem.add_dependency 'faraday_middleware', '~> 0.9'
+  gem.add_dependency 'hashie', '~> 3.4'
+  gem.add_development_dependency 'bundler', '~> 1.0'
+  gem.add_development_dependency 'rake', '~> 0.8'
+  gem.add_development_dependency 'rspec', '~> 2.4'
+  gem.add_development_dependency 'webmock', '>= 1.21.0'
+  gem.add_development_dependency 'simplecov', '>= 0.10.0'
+  gem.add_development_dependency 'coveralls', '>= 0.8.2'
+  gem.add_development_dependency 'rubocop', '>= 0.32.1 '
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+  gem.add_development_dependency 'yard', '~> 0.8'
+  gem.add_development_dependency 'pry', '>= 0.10.1'
+end

data/lib/exist.rb

@@ -0,0 +1,16 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'hashie'
+
+require 'exist/version'
+require 'exist/authentication'
+require 'exist/attributes'
+require 'exist/attribute_list'
+require 'exist/insight'
+require 'exist/insight_list'
+require 'exist/average'
+require 'exist/average_list'
+require 'exist/correlation'
+require 'exist/correlation_list'
+require 'exist/user'
+require 'exist/api'

data/lib/exist/api.rb

@@ -0,0 +1,122 @@
+module Exist
+  class API
+    include Authentication
+
+    attr_reader :client
+
+    def initialize(options = {})
+      @options = options
+      @token   = options[:token]
+      @client  = initialize_http_client
+
+      login! if credentials_provided?
+
+      unless api_key
+        raise ArgumentError.new(
+          "Must include user & password if no token provided or in environment"
+        )
+      end
+
+      client.headers['Authorization'] = "Token #{api_key}"
+    end
+
+    def me
+      User.new(client.get('users/$self/').body)
+    end
+
+    def overview(username = '$self')
+      User.new(client.get("users/#{username}/today/").body)
+    end
+
+    def attributes(limit: 31)
+      response = client.get('users/$self/attributes/', limit: limit).body
+
+      AttributeList.new(attributes: response)
+    end
+
+    # Date format is YYYY-mm-dd
+    def attribute(attribute, limit: 31, page: 1, oldest_date: nil, newest_date: nil)
+      response = client.get(
+        "users/$self/attributes/#{attribute}/",
+        page: page, limit: limit, date_min: oldest_date, date_max: newest_date
+      ).body
+      AttributeList.new(
+        attributes: response['results'],
+        total:      response['count'],
+      )
+    end
+
+    def insights(limit: 31, page: 1, oldest_date: nil, newest_date: nil)
+      response = client.get(
+        "users/$self/insights/",
+        page: page, limit: limit, date_min: oldest_date, date_max: newest_date
+      )
+
+      InsightList.new(
+        insights: response.body['results'],
+        total: response.body['count'],
+      )
+    end
+
+    def insights_for_attribute(attribute, limit: 31, page: 1, oldest_date: nil, newest_date: nil)
+      response = client.get(
+        "users/$self/insights/attribute/#{attribute}/",
+        page: page, limit: limit, date_min: oldest_date, date_max: newest_date
+      )
+      InsightList.new(
+        insights: response.body['results'],
+        total:    response.body['count'],
+      )
+    end
+
+    def averages
+      response = client.get('users/$self/averages/')
+      AverageList.new(averages: response.body)
+    end
+
+    def average_for_attribute(attribute, limit: 31, page: 1, oldest_date: nil, newest_date: nil)
+      response = client.get(
+        "users/$self/averages/attribute/#{attribute}/",
+        page: page, limit: limit, date_min: oldest_date, date_max: newest_date
+      ).body
+
+      AverageList.new(averages: response['results'], total: response['count'])
+    end
+
+    def correlations(username, attribute,
+                     limit: 31, page: 1, oldest_date: nil, newest_date: nil,
+                     latest_only: false)
+
+      params = { page: page, limit: limit }
+      if !latest_only
+        params.merge!(date_min: oldest_date, date_max: newest_date)
+      else
+        params.merge!(latest_only: true)
+      end
+
+      response = client.get(
+        "users/#{username}/correlations/attribute/#{attribute}/", params
+      ).body
+
+      CorrelationList.new(
+        correlations: response['results'],
+        total:        response['count']
+      )
+    end
+
+    private
+    def initialize_http_client
+      Faraday.new(url: base_url) do |conn|
+        conn.headers['User-Agent'] = "Exist Ruby #{Exist::VERSION}"
+        conn.request :json
+        conn.response :logger if ENV['FARADAY_DEBUG']
+        conn.response :json, content_type: /\bjson$/
+        conn.adapter Faraday.default_adapter
+      end
+    end
+
+    def base_url
+      'https://exist.io/api/1/'
+    end
+  end
+end

data/lib/exist/attribute_list.rb

@@ -0,0 +1,12 @@
+module Exist
+  class AttributeList < Hashie::Mash
+    include Hashie::Extensions::Coercion
+
+    coerce_key :attributes, Array[Attributes]
+
+    def size
+      attributes.size
+    end
+    alias :count :size
+  end
+end

data/lib/exist/attributes.rb

@@ -0,0 +1,4 @@
+module Exist
+  class Attributes < Hashie::Mash
+  end
+end

data/lib/exist/authentication.rb

@@ -0,0 +1,25 @@
+module Exist
+  module Authentication
+    def api_key
+      @token || ENV['EXIST_API_TOKEN']
+    end
+
+    def login!
+      resp = client.post(
+        'auth/simple-token',
+        username: @options[:username],
+        password: @options[:password]
+      )
+
+      if resp.body && resp.body['token']
+        @token = resp.body['token']
+      else
+        raise 'There was a problem authenticating with the API'
+      end
+    end
+
+    def credentials_provided?
+      @options[:username] && @options[:password]
+    end
+  end
+end

data/lib/exist/average.rb

@@ -0,0 +1,4 @@
+module Exist
+  class Average < Hashie::Mash
+  end
+end

data/lib/exist/average_list.rb

@@ -0,0 +1,11 @@
+module Exist
+  class AverageList < Hashie::Mash
+    include Hashie::Extensions::Coercion
+
+    coerce_key :averages, Array[Average]
+
+    def size
+      averages.size
+    end
+  end
+end

data/lib/exist/correlation.rb

@@ -0,0 +1,4 @@
+module Exist
+  class Correlation < Hashie::Mash
+  end
+end

data/lib/exist/correlation_list.rb

@@ -0,0 +1,7 @@
+module Exist
+  class CorrelationList < Hashie::Mash
+    include Hashie::Extensions::Coercion
+
+    coerce_key :correlations, Array[Correlation]
+  end
+end

data/lib/exist/insight.rb

@@ -0,0 +1,8 @@
+module Exist
+  class Insight < Hashie::Mash
+    include Hashie::Extensions::Coercion
+
+    coerce_key :created,     ->(v) { Time.parse(v) }
+    coerce_key :target_date, ->(v) { Date.parse(v) }
+  end
+end