qoolife-api 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 131cd58b0d6d85a8a1931db7cbd47ae1fcc6fa1e
+  data.tar.gz: 9021165ff6d7c19f965586be65895299502544ff
+SHA512:
+  metadata.gz: 8d09dff5d1a700c1af669fe2308a3b2316dd76544149341e62cdcb8e70945c4366fe5b405116cb72b91d966da71dc77e960ad111025953485b8877b6c1ca44e8
+  data.tar.gz: 6e76bbf153cc531a8338b321a9475c0e8ffb21cf14169b432852b4a5ab27a8eea69d531a0feff7fbf51c3b2bfb002d58bf1d8da6383fc6009460d23a281773f2

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 David Gil
+
+MIT License
+
+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,42 @@
+# QoolifeApi - Ruby client for Qoolife API
+
+Ruby API client for [Qoolife](https://qoolife.com), so you can easily plug it into your App.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'qoolife-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install qoolife-api
+
+## Usage
+
+Most of QoolifeApi methods need authentication with a Qoolife account. You need to provide this data to the client like this:
+
+    QoolifeApi.authenticate 'myuser@example.com', 'veeerysekret'
+
+After that, you can retrieve resources from the API using `ActiveResource` syntax.
+
+Some examples:
+
+    QoolifeApi::JournalEntries.all # will retrieve a paginated collection of the authenticated users' journal entries
+    QoolifeApi::JournalEntries.last.measurements # measurements from the last journal entry
+    QoolifeApi::Conversation.all # conversations of any kind where the user is watcher.
+    QoolifeApi::Conversation.last.posts.last # last message post in the last conversation where the user is watcher.
+
+Check the [API docs](http://developer.qoolife.com) for a full reference of what Qoolife API can do.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/qoolife-api/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,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/qoolife-api.rb

@@ -0,0 +1,21 @@
+# needed because the gem name is different from the require name and the gemspec does not support specifying the require path as in Gemfiles
+require 'active_resource'
+# needed for REST pagination
+require 'activeresource-response'
+require 'net/http'
+
+require "qoolife-api/version"
+
+require 'qoolife-api/pagination'
+require 'qoolife-api/paginated_collection'
+require 'qoolife-api/base'
+require 'qoolife-api/eager_load'
+require 'qoolife-api/errors'
+
+require 'qoolife-api/hello'
+
+require 'qoolife-api/conversation'
+require 'qoolife-api/journal_entry'
+require 'qoolife-api/measurement'
+require 'qoolife-api/post'
+require 'qoolife-api/questionnaire'

data/lib/qoolife-api/attachment.rb

@@ -0,0 +1,4 @@
+module QoolifeApi
+  class Attachment < Base
+  end
+end

data/lib/qoolife-api/base.rb

@@ -0,0 +1,24 @@
+module QoolifeApi
+  class Base < ActiveResource::Base
+    include Pagination
+
+    self.site = 'https://qoolife.com'
+    self.prefix = '/api/v1/'
+
+    self.include_root_in_json = true
+    self.collection_parser = PaginatedCollection
+
+    def self.endpoint
+      "#{site}#{prefix}"
+    end
+
+    def self.token=(token)
+      self.headers['Authorization'] = "Bearer #{token}"
+    end
+
+    def self.authorize(user, password)
+      self.user     = user
+      self.password = password
+    end
+  end
+end

data/lib/qoolife-api/comment.rb

@@ -0,0 +1,4 @@
+module QoolifeApi
+  class Comment < Base
+  end
+end

data/lib/qoolife-api/conversation.rb

@@ -0,0 +1,6 @@
+module QoolifeApi
+  class Conversation < Base
+    has_many :posts, class_name: 'qoolife_api/post'
+    has_many :watchers, class_name: 'qoolife_api/user'
+  end
+end

data/lib/qoolife-api/eager_load.rb

@@ -0,0 +1,32 @@
+# need eager loading base resources to avoid circular references when declaring has_X associations
+module QoolifeApi
+  class Attachment < Base
+  end
+
+  class Comment < Base
+  end
+
+  class Conversation < Base
+  end
+
+  class JournalEntry < Base
+  end
+
+  class Measurement < Base
+  end
+
+  class Post < Base
+  end
+
+  class Questionnaire < Base
+  end
+
+  class QuestionnaireResponse < Base
+  end
+
+  class User < Base
+  end
+
+  class Variable < Base
+  end
+end

data/lib/qoolife-api/errors.rb

@@ -0,0 +1,16 @@
+module QoolifeApi
+  class ActiveResource::Errors
+    def from_hash_with_pre_processing(messages, save_cache = false)
+      new_messages = if messages['error'] == 'invalid_resource'
+          messages['messages']
+        else
+          messages
+        end
+
+      from_hash_without_pre_processing(new_messages,save_cache)
+    end
+
+    alias_method :from_hash_without_pre_processing, :from_hash
+    alias_method :from_hash, :from_hash_with_pre_processing
+  end
+end

data/lib/qoolife-api/hello.rb

@@ -0,0 +1,8 @@
+module QoolifeApi
+  class Hello < Base
+    def self.say_hello
+      uri = URI(Base.endpoint + 'hello')
+      JSON.parse Net::HTTP.get_response(uri).body
+    end
+  end
+end

data/lib/qoolife-api/journal_entry.rb

@@ -0,0 +1,7 @@
+module QoolifeApi
+  class JournalEntry < Base
+    has_many :comments, class_name: 'qoolife_api/comment'
+    has_many :measurements, class_name: 'qoolife_api/measurement'
+    has_many :questionnaire_responses, class_name: 'qoolife_api/questionnaire_response'
+  end
+end

data/lib/qoolife-api/measurement.rb

@@ -0,0 +1,4 @@
+module QoolifeApi
+  class Measurement < Base
+  end
+end

data/lib/qoolife-api/paginated_collection.rb

@@ -0,0 +1,27 @@
+module QoolifeApi
+  class PaginatedCollection < ActiveResource::Collection
+    attr_accessor :first_page, :prev_page, :next_page, :last_page
+
+    def initialize(elements = [])
+      @elements   = elements
+      response    = QoolifeApi::Base.connection.http_response
+      response    = pagination_header_response_to_hash response['Link']
+      @first_page = response[:first]
+      @prev_page  = response[:prev]
+      @next_page  = response[:next]
+      @last_page  = response[:last]
+    end
+
+    private
+
+    def pagination_header_response_to_hash(response)
+      response.to_s.split(',').each_with_object({}) do |item, h|
+        items = item.split(';')
+        key   = items.last.gsub('rel=', '').gsub("\"", '').to_sym
+        value = items.first
+
+        h[key] = value
+      end
+    end
+  end
+end

data/lib/qoolife-api/pagination.rb

@@ -0,0 +1,24 @@
+module QoolifeApi
+  module Pagination
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.add_response_method :http_response
+    end
+
+    module ClassMethods
+      def find_all_across_pages(options = {})
+        collection = []
+        options[:params] ||= {}
+        options[:params][:page] = 1
+
+        begin
+          batch = find(:all, options)
+          collection += batch.to_a
+          options[:params][:page] += 1
+        end while batch.pagination['next'].present?
+
+        collection
+      end
+    end
+  end
+end

data/lib/qoolife-api/post.rb

@@ -0,0 +1,5 @@
+module QoolifeApi
+  class Post < Base
+    has_one :attachment, class_name: 'qoolife_api/attachment'
+  end
+end

data/lib/qoolife-api/questionnaire.rb

@@ -0,0 +1,5 @@
+module QoolifeApi
+  class Questionnaire < Base
+    has_many :variables, class_name: 'qoolife_api/variable'
+  end
+end

data/lib/qoolife-api/questionnaire_response.rb

@@ -0,0 +1,5 @@
+module QoolifeApi
+  class QuestionnaireResponse < Base
+    has_many :measurements, class_name: 'qoolife_api/measurement'
+  end
+end

data/lib/qoolife-api/user.rb

@@ -0,0 +1,4 @@
+module QoolifeApi
+  class User < Base
+  end
+end

data/lib/qoolife-api/variable.rb

@@ -0,0 +1,4 @@
+module QoolifeApi
+  class Variable < Base
+  end
+end

data/lib/qoolife-api/version.rb

@@ -0,0 +1,3 @@
+module QoolifeApi
+  VERSION = "0.0.3"
+end

data/qoolife_api.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'qoolife-api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "qoolife-api"
+  spec.version       = QoolifeApi::VERSION
+  spec.authors       = ["David Gil"]
+  spec.email         = ["dgilperez@qoolife.com"]
+  spec.summary       = %q{Ruby wrapper for Qoolife API}
+  spec.description   = %q{Ruby API client for Qoolife, so you can easily plug it into your App}
+  spec.homepage      = "https://github.com/qoolife/qoolife-api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry-byebug"
+
+  spec.add_runtime_dependency 'activeresource', '~> 4.0'
+  spec.add_runtime_dependency 'activeresource-response', '~> 1.0'
+end

data/spec/qoolife_api_spec.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe QoolifeApi do
+  describe "hello world" do
+    it "should answer world when said hello" do
+      expect(QoolifeApi::Hello.say_hello).to eq({ 'hello' => 'world' })
+    end
+  end
+
+  describe "journal entries" do
+    it "should return 401 unauthorized for unauthorized user" do
+      expect { QoolifeApi::JournalEntry.all }.to raise_error(ActiveResource::UnauthorizedAccess)
+    end
+
+    it "should list journal entries for authorized user" do
+      authorize!
+
+      all_entries = QoolifeApi::JournalEntry.all
+
+      expect(all_entries.size).to eq(20)
+      expect(all_entries.first).to be_a(QoolifeApi::JournalEntry)
+      expect(all_entries.first.attributes.keys).to eq(["id", "user_id", "author_id", "body", "date", "created_at", "measurements", "questionnaire_responses"])
+    end
+  end
+
+  def authorize!
+    # use your own credentials to test
+    QoolifeApi::Base.authorize 'youruser', 'yourpassword'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'qoolife-api'
+require 'pry-byebug'

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: qoolife-api
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- David Gil
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activeresource-response
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Ruby API client for Qoolife, so you can easily plug it into your App
+email:
+- dgilperez@qoolife.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/qoolife-api.rb
+- lib/qoolife-api/attachment.rb
+- lib/qoolife-api/base.rb
+- lib/qoolife-api/comment.rb
+- lib/qoolife-api/conversation.rb
+- lib/qoolife-api/eager_load.rb
+- lib/qoolife-api/errors.rb
+- lib/qoolife-api/hello.rb
+- lib/qoolife-api/journal_entry.rb
+- lib/qoolife-api/measurement.rb
+- lib/qoolife-api/paginated_collection.rb
+- lib/qoolife-api/pagination.rb
+- lib/qoolife-api/post.rb
+- lib/qoolife-api/questionnaire.rb
+- lib/qoolife-api/questionnaire_response.rb
+- lib/qoolife-api/user.rb
+- lib/qoolife-api/variable.rb
+- lib/qoolife-api/version.rb
+- qoolife_api.gemspec
+- spec/qoolife_api_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/qoolife/qoolife-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Qoolife API
+test_files:
+- spec/qoolife_api_spec.rb
+- spec/spec_helper.rb