one45 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 16dc956d8f62c8d9d3e2f891d57b92c9a74a9bb2
+  data.tar.gz: cd6ce58c8b2faca3a4ba250a9a219d4ba1e06f46
+SHA512:
+  metadata.gz: e13dd53ac33f7c098fa29230195184c613d4d53042ee5b4ca8864da1f05089c1a37c540ec30a26f0c1162f1effdb02d9aa0456ebc196babfa0cbcc6de08d9acd
+  data.tar.gz: 742d0d3585d0df43c780920e2fa628f8fda980564419e6b3b9eb3e6e4b5a6ab391f61723367f59f42c0a7760102c1fc9c82c044df2e75bfdcb4bee9120e21765

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+TODO.md
+*.gem
+test/cassettes/*
+test/config/application.rb

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.5

data/Gemfile

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

data/README.md

@@ -0,0 +1,73 @@
+# One45
+
+Ruby bindings for the [one45 API](https://api.one45.com/api/docs/all).
+
+Under development since most endpoints remain listed as Early Access/In Development.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'one45'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install one45
+
+## Usage
+
+Add your school credentials. In a Rails application create a new initializer `config/initializers/one45.rb`
+
+```
+One45.api_host      = ENV['ONE45_API_HOST']
+One45.client_key    = ENV['ONE45_CLIENT_KEY']
+One45.client_secret = ENV['ONE45_CLIENT_SECRET']
+One45.access_token  = ENV['ONE45_ACCESS_TOKEN'] # optional
+```
+
+A request for a new token will be made prior to each call if no access token provided (which is slowing response).
+In future, an alternate solution would be to implement OAuth2 strategy.
+
+Retrieve collection
+
+```
+One45::Evaluations.list(
+  target_id: 111,
+  target_role_id: 3,
+  evaluator_role_id: 2,
+  completed_on: "2015-01-01|2015-12-31",
+  event_category: "rotation",
+  limit: 100
+)
+```
+
+Fetch specific record by One45 ID
+
+```
+One45::Questions.find(504)
+```
+
+__Current limits__
+
+- Only GET methods so far (POST, DELETE, PATCH, PUT are excluded at the moment)
+- Only token#generate is implemented
+
+For complete list of implementation please refer to test file.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+You need to set up credentials to run the tests. Clone and rename `application.sample.rb` under `test/config`.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/uOttawaMedtech/one45-ruby.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "one45"
+
+# 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

data/bin/setup

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

data/lib/one45.rb

@@ -0,0 +1,99 @@
+require "one45/version"
+
+# Dependencies
+require "restclient"
+
+# Common
+require "one45/base"
+
+# API resources
+require "one45/evaluations"
+require "one45/forms"
+require "one45/groups"
+require "one45/questions"
+require "one45/rotations"
+require "one45/users"
+
+# Errors
+require "one45/errors/one45_error"
+
+
+module One45
+  VERBS = %w(get post put)
+
+  class << self
+    attr_accessor :api_host, :client_key, :client_secret, :access_token
+
+    def generate_token(client_key, client_secret)
+      params = { params: { client_key: client_key, client_secret: client_secret} }
+      begin
+        response = RestClient.get(token_url, params)
+        @access_token = JSON.parse(response)['access_token']
+        # puts "generated access_token: #{@access_token}"
+        @access_token
+      rescue => e
+        One45Error.new("error: #{e.class} : #{e.response} : #{e.response}")
+      end
+    end
+
+    def api_url
+      "https://#{One45.api_host}/web/one45_stage.php/api/v1"
+    end
+
+    def token_url
+      "https://#{One45.api_host}/web/one45_stage.php/api/token/generate"
+    end
+
+    VERBS.each do |verb|
+      define_method verb do |path, *params|
+        send_request(verb, path, *params)
+      end
+    end
+
+  private
+
+    def validate_configuration
+      [@api_host, @client_key, @client_secret].each do |config|
+        raise One45Error.new("api_host, client_key or client_secret not set") if config.nil?
+      end
+    end
+
+    def send_request(verb, path, options = {})
+      validate_configuration
+
+      url = path.start_with?('http') ? path : api_url + "/#{path}"
+
+      url = URI::encode(url)
+
+      params = format_body_params(options, @access_token) if @access_token
+
+      begin
+        response = RestClient.send(verb, url, params)
+      rescue RestClient::Unauthorized
+        # token may be expired or nil
+        # submit request again with a fresh token
+        @access_token = generate_token(@client_key, @client_secret)
+        params = format_body_params(options, @access_token)
+        response = RestClient.send(verb, url, params)
+      rescue => e
+        One45Error.new("error: #{e.class} : #{e.response} : #{e.response}")
+      end
+
+      JSON.parse response if response && response.length >= 2
+      # http://stackoverflow.com/questions/8390256/a-json-text-must-at-least-contain-two-octets
+    end
+
+    def format_body_params(options, access_token)
+      # insert access_token in the original hash
+      token_hash = { access_token: access_token }
+      options.merge! token_hash
+      # nest options under the key 'params'
+      params = { params: options }
+    end
+
+    def default_headers
+      { 'Content-Type' => "application/json",
+        'Accept' => "application/json" }
+    end
+  end
+end

data/lib/one45/base.rb

@@ -0,0 +1,14 @@
+module One45
+  class Base
+
+    def self.list(options = {})
+      One45.get resource_url, options
+    end
+
+    def self.find(id)
+      url = "#{resource_url}/#{id}"
+      One45.get url
+    end
+
+  end
+end

data/lib/one45/errors/one45_error.rb

@@ -0,0 +1,20 @@
+module One45
+  class One45Error < StandardError
+    attr_reader :message
+    attr_reader :http_status
+    attr_reader :http_body
+    attr_reader :json_body
+
+    def initialize(message=nil, http_status=nil, http_body=nil, json_body=nil)
+      @message = message
+      @http_status = http_status
+      @http_body = http_body
+      @json_body = json_body
+    end
+
+    def to_s
+      status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
+      "#{status_string}#{@message}"
+    end
+  end
+end

data/lib/one45/evaluations.rb

@@ -0,0 +1,26 @@
+module One45
+  class Evaluations < Base
+
+    def self.answers(id)
+      url = "#{resource_url}/#{id}/answers"
+      One45.get url
+    end
+
+    def self.contributors(id)
+      url = "#{resource_url}/#{id}/contributors"
+      One45.get url
+    end
+
+    def self.question_answers(id, question_id)
+      url = "#{resource_url}/#{id}/question/#{question_id}/answer"
+      One45.get url
+    end
+
+    private
+
+      def self.resource_url
+        "evaluations"
+      end
+
+  end
+end

data/lib/one45/forms.rb

@@ -0,0 +1,21 @@
+module One45
+  class Forms < Base
+
+    def self.groups(id)
+      url = "#{resource_url}/#{id}/groups"
+      One45.get url
+    end
+
+    def self.questions(id)
+      url = "#{resource_url}/#{id}/questions"
+      One45.get url
+    end
+
+    private
+
+      def self.resource_url
+        "forms"
+      end
+
+  end
+end

data/lib/one45/groups.rb

@@ -0,0 +1,16 @@
+module One45
+  class Groups < Base
+
+    def self.subgroups(id)
+      url = "#{resource_url}/#{id}/children"
+      One45.get url
+    end
+
+    private
+
+      def self.resource_url
+        "groups"
+      end
+
+  end
+end

data/lib/one45/questions.rb

@@ -0,0 +1,11 @@
+module One45
+  class Questions < Base
+
+    private
+
+      def self.resource_url
+        "questions"
+      end
+
+  end
+end

data/lib/one45/rotations.rb

@@ -0,0 +1,11 @@
+module One45
+  class Rotations < Base
+
+    private
+
+      def self.resource_url
+        "rotations"
+      end
+
+  end
+end

data/lib/one45/users.rb

@@ -0,0 +1,25 @@
+module One45
+  class Users < Base
+
+    def self.preferences(id)
+      url = "#{resource_url}/#{id}/preferences"
+      One45.get url
+    end
+
+    def self.todos(id, options = {})
+      url = "#{resource_url}/#{id}/todos"
+      One45.get url
+    end
+
+    def self.evaluations(id, options = {})
+      url = "#{resource_url}/#{id}/todos/evaluations"
+      One45.get url
+    end
+
+    private
+
+      def self.resource_url
+        "people"
+      end
+  end
+end

data/lib/one45/version.rb

@@ -0,0 +1,3 @@
+module One45
+  VERSION = "0.1.0"
+end

data/one45.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'one45/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "one45"
+  spec.version       = One45::VERSION
+  spec.authors       = ["Olivier"]
+  spec.email         = ["osimart@uottawa.ca", "olivier@yafoy.com"]
+
+  spec.summary       = "Ruby bindings for the one45 API"
+  spec.description   = "Interact with one45 key endpoints"
+  spec.homepage      = "https://github.com/uOttawaMedtech/one45-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rest-client', '~> 1.7'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  # TESTS
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-reporters", "~> 1.0"
+  spec.add_development_dependency "vcr", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 1.22"
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: one45
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Olivier
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+description: Interact with one45 key endpoints
+email:
+- osimart@uottawa.ca
+- olivier@yafoy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/one45.rb
+- lib/one45/base.rb
+- lib/one45/errors/one45_error.rb
+- lib/one45/evaluations.rb
+- lib/one45/forms.rb
+- lib/one45/groups.rb
+- lib/one45/questions.rb
+- lib/one45/rotations.rb
+- lib/one45/users.rb
+- lib/one45/version.rb
+- one45.gemspec
+homepage: https://github.com/uOttawaMedtech/one45-ruby
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for the one45 API
+test_files: []