upkey-helios-client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4895a1201f1ef7f74064e41e59d454d7a8e7107a
+  data.tar.gz: ac512531b79f1c8ef9372818808d9b0b623c43a3
+SHA512:
+  metadata.gz: abeb94ba2f32fa3617abdd15ab4ec8c83cd03fdde5f4f65ce6da9430de8aa0f6de63a935aadcdd6babb6c584df5ceefd5f71f398f3179c9088e67b1528adab74
+  data.tar.gz: aa624f27206911c729f91f492e7e1dc1342e5f8ebd2d4fa229a97b42368f1cd503329349e7cd194a5083a3189a763d9dda5384365bab7772544efa6e2d439f75

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,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.15.3

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 elliott.a.young@gmail.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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in upkey-helios-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 ElliottAYoung
+
+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,118 @@
+# Upkey::Helios::Client
+
+This gem is the interface for the Upkey::Helios API, allowing Users to easily access the desired information.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'upkey-helios-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install upkey-helios-client
+
+## Usage
+
+To use the app you must first set up your Client for this gem:
+
+```ruby
+client = Upkey::Helios::Client.new({ 
+	access_key: ACCESS_KEY, 
+	helios_url: HELIOS_URL 
+})
+```
+
+This will spin up a client with the necessary credentials and information needed to find and communicate with the Helios API. After this has been set up you can begin using the API by passing path information and parameters as necessary. Details on this are found below.
+
+### Basic Routes
+
+The gem will determine the API endpoint you are trying to access by what path information you pass in the array. For example, to reach `/api/students` you would pass `[{ students: nil }]` as the `path_info` - and for `/api/students/1` you would pass `[{ students: 1 }]`. 
+
+Examples on the multiple approaches for all REST verbs are included below:
+
+```ruby
+# Get Multiple
+client.get([{ students: 1 }])
+
+# Get Single
+client.get([{ students: 1 }])
+
+# Post New
+client.post([{ students: 1 }], student_params)
+
+# Patch/Put Single
+client.patch([{ students: 1 }], student_params)
+OR
+client.put([{ students: 1 }], student_params)
+
+# Delete Single
+client.delete([{ students: 1 }])
+
+```
+
+### Nested Routes
+
+Nested routes work exactly like basic routes, only the `path_info` Array should contain information for all relevant parent information. For example with the route `/api/students/1/attributes` you will have the following:
+
+```ruby
+# Get Multiple
+client.get([{ students: 1 }, { attributes: nil }])
+
+# Get Single
+client.get([{ students: 1 }, { attributes: 1 }])
+
+# Post New
+client.post([{ students: 1 }, { attributes: nil }], attribute_params)
+
+# Patch/Put Single
+client.patch([{ students: 1 }, { attributes: 1 }], attribute_params)
+OR
+client.put([{ students: 1 }, { attributes: 1 }], attribute_params)
+
+# Delete Single
+client.delete([{ students: 1 }, { attributes: 1 }])
+
+```
+
+In this example `{ students: 1 }` passes the `student_id` param and `{ attributes: 1 }` passes the general `id` param.
+
+### Response
+
+The beauty of this gem really comes down to the general, uniform response it will give from the API. It passes these responses in `Upkey::Helios::Response` objects that have the following properties:
+
+```ruby
+# For /api/students/1/attributes
+
+<Upkey::Helios::Response
+	@contents: [Array of Attribute Objects],
+	@raw_headers: { Header Information Hash },
+	@status: Status Code Integer
+>
+```
+
+You can then access parsed information by simply calling `response.contents`, `response.status` and `response.raw_headers` accordingly.
+
+## 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/beupkey/upkey-helios-client. 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).
+
+## Code of Conduct
+
+Everyone interacting in the Upkey::Helios::Client project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/beupkey/upkey-helios-client/blob/master/CODE_OF_CONDUCT.md).

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 "upkey/helios/client"
+
+# 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/upkey/helios.rb

@@ -0,0 +1,6 @@
+require "upkey/helios/version"
+
+module Upkey
+  module Helios
+  end
+end

data/lib/upkey/helios/accessor.rb

@@ -0,0 +1,21 @@
+module Upkey
+  module Helios
+    module Accessor
+      def self.query(client, method, path_info, params = {})
+        @client = client
+        path = Upkey::Helios::Builder.path(path_info)
+
+        access_helios(method, path, params)
+      end
+
+      class << self
+        private
+
+        def access_helios(method, path, params)
+          client_params = params.merge({ access_key: @client.access_key })
+          @client.conn.send(method.to_s, *[path, client_params])
+        end
+      end
+    end
+  end
+end

data/lib/upkey/helios/builder.rb

@@ -0,0 +1,19 @@
+module Upkey
+  module Helios
+    module Builder
+      def self.path(path_info_array)
+        path_str = "/api"
+
+        path_info_array.each do |section|
+          if section.values[0].nil?
+            path_str += "/#{section.keys[0]}"
+          else
+            path_str += "/#{section.keys[0]}/#{section.values[0]}"
+          end
+        end
+
+        path_str
+      end
+    end
+  end
+end

data/lib/upkey/helios/client.rb

@@ -0,0 +1,42 @@
+require 'upkey/helios/accessor'
+require 'upkey/helios/builder'
+require 'upkey/helios/responder'
+require 'upkey/helios/response'
+
+require 'upkey/helios/errors/missing_argument_error'
+require 'upkey/helios/errors/helios_response_error'
+
+require 'faraday'
+
+module Upkey
+  module Helios
+    class Client
+      attr_reader :access_key, :helios_url, :conn
+
+      def initialize(args = {})
+        raise MissingArgumentError unless args[:access_key] && args[:helios_url]
+
+        @access_key = args[:access_key]
+        @helios_url = args[:helios_url]
+        @conn = set_up_faraday
+      end
+
+      def method_missing(*args)
+        args[2].nil? ? (params = {}) : (params = args[2])
+        response = Upkey::Helios::Accessor.query(self, args[0], args[1], params)
+
+        Upkey::Helios::Responder.parse(response)
+      end
+
+      private
+
+      def set_up_faraday
+        Faraday.new(:url => "#{@helios_url}") do |faraday|
+          faraday.request  :url_encoded
+          faraday.response :logger
+          faraday.adapter  Faraday.default_adapter
+        end
+      end
+    end
+  end
+end

data/lib/upkey/helios/errors/helios_response_error.rb

@@ -0,0 +1,9 @@
+module Upkey
+  module Helios
+    class HeliosResponseError < StandardError
+      def initialize(msg = "An error has occurred on Helios. Please check the Helios logs for more Details.")
+        super
+      end
+    end
+  end
+end

data/lib/upkey/helios/errors/missing_argument_error.rb

@@ -0,0 +1,9 @@
+module Upkey
+  module Helios
+    class MissingArgumentError < ArgumentError
+      def initialize(msg = "Missing Arguments for Upkey::Helios::Client. Required Arguments: [access_key, helios_url]")
+        super
+      end
+    end
+  end
+end

data/lib/upkey/helios/responder.rb

@@ -0,0 +1,18 @@
+module Upkey
+  module Helios
+    module Responder
+      def self.parse(response)
+        case response.status
+        when 404, 401, 200, 204
+          Upkey::Helios::Response.new({
+            status: response.status,
+            contents: response.body,
+            headers: response.headers
+          })
+        else
+          raise HeliosResponseError
+        end
+      end
+    end
+  end
+end

data/lib/upkey/helios/response.rb

@@ -0,0 +1,28 @@
+require 'json'
+
+module Upkey
+  module Helios
+    class Response
+      attr_reader :raw_headers, :contents, :status
+
+      def initialize(args = {})
+        @status = args[:status]
+        @raw_headers = args[:headers]
+        @contents = parsed_contents(args[:contents], args[:error])
+      end
+
+      private
+
+      def parsed_contents(contents, error)
+        return [error] if @status >= 400
+
+        begin
+          JSON.parse(contents) unless @status == 204
+        rescue JSON::ParserError => e
+          [contents]
+        end
+      end
+
+    end
+  end
+end

data/lib/upkey/helios/version.rb

@@ -0,0 +1,5 @@
+module Upkey
+  module Helios
+    VERSION = "1.0.0"
+  end
+end

data/upkey-helios-client.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "upkey/helios/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "upkey-helios-client"
+  spec.version       = Upkey::Helios::VERSION
+  spec.authors       = ["ElliottAYoung"]
+  spec.email         = ["elliott.a.young@gmail.com"]
+
+  spec.summary       = "The Ruby Client for the Upkey Helios API"
+  spec.description   = "The Ruby Client for the Upkey Helios API"
+  spec.homepage      = "https://github.com/beupkey/upkey-helios-client.git"
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "faraday"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: upkey-helios-client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- ElliottAYoung
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: pry
+  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: faraday
+  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'
+description: The Ruby Client for the Upkey Helios API
+email:
+- elliott.a.young@gmail.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/upkey/helios.rb
+- lib/upkey/helios/accessor.rb
+- lib/upkey/helios/builder.rb
+- lib/upkey/helios/client.rb
+- lib/upkey/helios/errors/helios_response_error.rb
+- lib/upkey/helios/errors/missing_argument_error.rb
+- lib/upkey/helios/responder.rb
+- lib/upkey/helios/response.rb
+- lib/upkey/helios/version.rb
+- upkey-helios-client.gemspec
+homepage: https://github.com/beupkey/upkey-helios-client.git
+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.5.1
+signing_key: 
+specification_version: 4
+summary: The Ruby Client for the Upkey Helios API
+test_files: []