rallio 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85be5c78b7bb8274a8437ea72945e880182081ad
+  data.tar.gz: 45de8bdacafe7c047967cb9fe76b8d6bb5069bc2
+SHA512:
+  metadata.gz: 04145be6c2b6e068f4e2b65fffce4d0f785f8035f2053bb3a1ad93906565400f6cf88d79e2d74dea9e651fae387757d4cf81a7c15a6bfbcb730d99044d0fbce0
+  data.tar.gz: a1ff4013ecd7204952f1c24631546af1e83daa35b125906e36cdbd154c5aef4f4adb6635ce184a891c3d9ef0ff75a9f97575fac3961ff20572e305c8eb65fc72

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_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/.travis.yml

@@ -0,0 +1,10 @@
+addons:
+  code_climate:
+    repo_token: b4f64f23595e47336c979c86290bcfce4d0af67a767f5394b87cce72a43a8d5a
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.5
+after_success:
+  - bundle exec codeclimate-test-reporter

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 jdguzman@mac.com. 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 rallio.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 JD Guzman
+
+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,133 @@
+[![Code Climate](https://codeclimate.com/github/jdguzman/rallio/badges/gpa.svg)](https://codeclimate.com/github/jdguzman/rallio)
+[![Build Status](https://travis-ci.org/jdguzman/rallio.svg?branch=master)](https://travis-ci.org/jdguzman/rallio)
+[![Test Coverage](https://codeclimate.com/github/jdguzman/rallio/badges/coverage.svg)](https://codeclimate.com/github/jdguzman/rallio/coverage)
+[![Issue Count](https://codeclimate.com/github/jdguzman/rallio/badges/issue_count.svg)](https://codeclimate.com/github/jdguzman/rallio)
+
+# Rallio
+
+This is a ruby implementation of the Rallio API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rallio'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rallio
+
+## Usage
+
+The documentation here is specific to the gem and it's usage. Detailed
+information on the Rallio API can be found at
+https://mark.przepiora.ca/tmp/rallio-public-api-documentation.
+
+### Configuration
+
+In order to use the gem you will need to configure your `application_id` and
+`application_secret` provided to you by Rallio. If you are using this within a
+Rails context you should do this in an initializer. Otherwise you need to set
+this up before you make any calls to the API.
+
+```ruby
+Rallio.application_id = '<your id>'               # => '<your_id>'
+Rallio.application_secret = '<your secret>'       # => '<your secret>'
+```
+
+### User
+
+#### .accessible_users
+
+The user class can be used to access all available users for a given
+application.
+
+```ruby
+Rallio::User.accessible_users
+# =>
+# [<Rallio::User:0x007fc325b36808 @id=100, @email="bob@yourcompany.com", @first_name="Bob", @last_name="Anderson", @accounts=[], @franchisors=[]>]
+```
+
+#### #sign_on_tokens
+
+With an instantiated user object you can call to get a single sign-on token
+for the given user.
+
+```ruby
+user
+# => <Rallio::User @id=100, @email="bob@yourcompany.com", @first_name="Bob", @last_name="Anderson", @accounts=[], @franchisors=[]>
+
+user.sign_on_tokens
+# => <Rallio::SignOnToken @token="15ad86b2ede6", @expires_at=#<DateTime: 2015-04-16T23:5...,321000000n),+0s,2299161j)>, @url="https://app.rallio.com/api/internal/sign_on_tokens/15ad86b2ede6">
+```
+
+#### #access_token
+
+With an instantiated user object you can call to get an access token for the
+given user.
+
+```ruby
+user
+# => <Rallio::User @id=100, @email="bob@yourcompany.com", @first_name="Bob", @last_name="Anderson", @accounts=[], @franchisors=[]>
+
+user.access_token
+# => <Rallio::AccessToken @access_token="4a25dd89e50bd0a0db1eeae65864fe6b", @user_id=100, @expires_at=nil, @scopes="user_info basic_access">
+```
+
+### SignOnToken
+
+#### .create
+
+A sign-on token can also be created independently of a user object. Calling the
+`SignOnToken.create` method with a user id will return a sign-on token for that
+user.
+
+```ruby
+Rallio::SignOnToken.create(user_id: 100)
+# => <Rallio::SignOnToken:0x007fa9d703b7d0 @token="15ad86b2ede6", @expires_at=#<DateTime: 2015-04-16T23:5...,321000000n),+0s,2299161j)>, @url="https://app.rallio.com/api/internal/sign_on_tokens/15ad86b2ede6">
+```
+
+### Access Token
+
+#### .create
+
+An access token can also be created independently of a user object. Calling the
+`AccessToken.create` method with a user id will return an access token for that
+user.
+
+```ruby
+Rallio::AccessToken.create(user_id: 100)
+# => <Rallio::AccessToken:0x007fd3fc9fea70 @access_token="4a25dd89e50bd0a0db1eeae65864fe6b", @user_id=100, @expires_at=nil, @scopes="user_info basic_access">
+```
+
+#### #destroy
+
+Destroys the access_token passed in for the object.
+
+```ruby
+access_token = Rallio::AccessToken.new(access_token: '4a25dd89e50bd0a0db1eeae65864fe6b')
+# => <Rallio::AccessToken:0x007fd3fc9fea70 @access_token="4a25dd89e50bd0a0db1eeae65864fe6b", @user_id=nil, @expires_at=nil, @scopes=nil>
+
+access_token.destroy                              # => true
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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/jdguzman/rallio. 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](http://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 "rallio"
+
+# 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__)

data/bin/setup

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

data/lib/rallio/access_token.rb

@@ -0,0 +1,19 @@
+module Rallio
+  class AccessToken < Base
+    attribute :access_token, String
+    attribute :user_id, Integer
+    attribute :expires_at, DateTime
+    attribute :scopes, String
+
+    def self.create(user_id:)
+      response = self.post("/users/#{user_id}/access_token", headers: app_credentials)
+      new response.parsed_response
+    end
+
+    def destroy
+      headers = { 'Authentication' => "Bearer #{access_token}" }
+      self.class.delete('/access_token', headers: headers)
+      true
+    end
+  end
+end

data/lib/rallio/account.rb

@@ -0,0 +1,4 @@
+module Rallio
+  class Account < Franchisor
+  end
+end

data/lib/rallio/base.rb

@@ -0,0 +1,17 @@
+module Rallio
+  class Base
+    include HTTParty
+    include Virtus.model
+
+    base_uri 'https://app.rallio.com/api/v1'
+
+    private
+
+    def self.app_credentials
+      {
+        'X-Application-ID' => Rallio.application_id,
+        'X-Application-Secret' => Rallio.application_secret
+      }
+    end
+  end
+end

data/lib/rallio/franchisor.rb

@@ -0,0 +1,8 @@
+module Rallio
+  class Franchisor
+    include Virtus.model
+
+    attribute :id, Integer
+    attribute :name, String
+  end
+end

data/lib/rallio/sign_on_token.rb

@@ -0,0 +1,12 @@
+module Rallio
+  class SignOnToken < Base
+    attribute :token, String
+    attribute :expires_at, DateTime
+    attribute :url, String
+
+    def self.create(user_id:)
+      response = self.post("/users/#{user_id}/sign_on_tokens", headers: app_credentials)
+      new response.parsed_response
+    end
+  end
+end

data/lib/rallio/user.rb

@@ -0,0 +1,25 @@
+module Rallio
+  class User < Base
+    attribute :id, Integer
+    attribute :email, String
+    attribute :first_name, String
+    attribute :last_name, String
+    attribute :accounts, Array[Account]
+    attribute :franchisors, Array[Franchisor]
+
+    def self.accessible_users
+      response = self.get('/accessible_users', headers: app_credentials)
+      response.parsed_response[:users].map { |u| User.new(u) }
+    end
+
+    def sign_on_tokens
+      SignOnToken.create(user_id: id)
+      # response = self.class.post("/users/#{id}/sign_on_tokens", headers: app_credentials)
+      # SignOnToken.new response.parsed_response[:sign_on_token]
+    end
+
+    def access_token
+      @access_token ||= AccessToken.create(user_id: id)
+    end
+  end
+end

data/lib/rallio/version.rb

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

data/lib/rallio.rb

@@ -0,0 +1,23 @@
+require 'httparty'
+require 'virtus'
+require 'autoloaded'
+
+module Rallio
+  Autoloaded.class {}
+
+  def self.application_id=(value)
+    @application_id = value
+  end
+
+  def self.application_id
+    @application_id
+  end
+
+  def self.application_secret=(value)
+    @application_secret = value
+  end
+
+  def self.application_secret
+    @application_secret
+  end
+end

data/rallio.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rallio/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rallio"
+  spec.version       = Rallio::VERSION
+  spec.authors       = ["JD Guzman"]
+  spec.email         = ["jdguzman@mac.com"]
+
+  spec.summary       = %q{Rallio API}
+  spec.description   = %q{Rallio API implementation in Ruby}
+  spec.homepage      = "https://github.com/jdguzman/rallio"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "virtus", "~> 1.0"
+  spec.add_dependency "httparty", "~> 0.14"
+  spec.add_dependency "autoloaded", "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-its", "~> 1.2"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0"
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: rallio
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- JD Guzman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: virtus
+  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'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: autoloaded
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: rspec
+  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: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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'
+description: Rallio API implementation in Ruby
+email:
+- jdguzman@mac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rallio.rb
+- lib/rallio/access_token.rb
+- lib/rallio/account.rb
+- lib/rallio/base.rb
+- lib/rallio/franchisor.rb
+- lib/rallio/sign_on_token.rb
+- lib/rallio/user.rb
+- lib/rallio/version.rb
+- rallio.gemspec
+homepage: https://github.com/jdguzman/rallio
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Rallio API
+test_files: []