ketra 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 37720a5e1d8c838fe7032637baf15b4a1d2f6dca
+  data.tar.gz: 584b3a99ba32c4bd5cf2c1ab2a3342acb3322c78
+SHA512:
+  metadata.gz: 52dd7bc1e83bf51bdc8946c56bddbb0da3e1e99c7f217ec0b769b0d2b8b8b1ca7919623c1d767f66f985cc4d608089f521f4791c67693b54aa86aad28b6f105a
+  data.tar.gz: 708f84945cbc504c80592aa1226b1d6b3d188963aa1a56c5aae5f16902329c89707c0d9e6546d14edf800fb56d32af31b1acefc308456a33b5b9995d51d04187

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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,56 @@
+# Ketra
+
+## Description
+
+The Ketra gem provides a friendly Ruby interface to the Ketra API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ketra'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ketra
+
+## Usage
+
+In order to use this gem you will need to contact Ketra Support and get assigned a client_id and client_secret
+
+### Authentication
+
+#### Password grant
+
+```ruby
+require 'ketra'
+Ketra.client_id = 'YOUR CLIENT ID'
+Ketra.client_secret = 'YOUR CLIENT SECRET'
+Ketra.authorization_grant = :password
+credentials = { username: 'YOUR DESIGN STUDIO USERNAME', password: 'YOUR DESIGN STUDIO PASSWORD' }
+Ketra.authorize(credentials)
+access_token = Ketra.access_token
+```
+
+
+## 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/kennyjpowers/ketra. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](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 "ketra"
+
+# 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/ketra.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ketra/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ketra"
+  spec.version       = Ketra::VERSION
+  spec.authors       = ["Kenneth Priester"]
+  spec.email         = ["kennethjpriester@gmail.com"]
+
+  spec.summary       = %q{Provides a friendly ruby-like wrapper for the Ketra API}
+  spec.description   = %q{A friendly Ruby interface to the Ketra API}
+  spec.homepage      = "http://github.com/kennyjpowers/ketra"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem 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 { |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 "oauth2", "~> 1.3.1"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/ketra.rb

@@ -0,0 +1,111 @@
+require 'oauth2'
+
+require "ketra/version"
+require "ketra/ketra_client"
+
+module Ketra
+  class Error < RuntimeError; end
+
+  class << self
+    attr_writer :callback_url
+    #TODO add permission_scopes
+  end
+
+  # Make Ketra.client_id and Ketra.client_secret global but also local to threads
+
+  def self.client_id
+    Thread.current[:ketra_client_id] || @client_id
+  end
+
+  def self.client_id=(id)
+    @client_id ||= id
+    Thread.current[:ketra_client_id] = id
+  end
+
+  def self.client_secret
+    Thread.current[:client_secret] || @client_secret    
+  end
+
+  def self.client_secret=(secret)
+    @client_secret ||= secret
+    Thread.current[:ketra_client_secret] = secret
+  end
+
+  PRODUCTION_HOST = 'https://my.goketra.com'
+  API_VERSION = 'v4'
+
+  # Set the environment, accepts :production (TODO add :sandbox environment).
+  # Defaults to :production
+  # will raise an exception when set to an unrecognized environment
+  def self.environment=(env)
+    unless [:production].include?(env)
+      raise(ArguementError, "environment must be set to :production")
+    end
+    @environment = env
+    @host = PRODUCTION_HOST
+  end
+
+  def self.environment
+    @environment || :production
+  end
+
+  def self.host
+    @host || PRODUCTION_HOST
+  end
+
+  # Set the authorization grant type
+  # accepts either :implicit or :password
+  # Defaults to :implicit
+  def self.authorization_grant=(grant_type)
+    unless [:code, :password].include?(grant_type)
+      raise(ArgumentError, "grant type must be set to either :code or :password")
+    end
+    @authorization_grant = grant_type
+  end
+  
+  def self.authorization_grant
+    @authorization_grant || :code
+  end
+  
+  # Allow throwing API errors
+  def self.silent_errors=(bool)
+    unless [TrueClass, FalseClass].include?(bool.class)
+      raise(ArguementError, "Silent errors must be set to either true or false")
+    end
+    @silent_errors = bool
+  end
+
+  def self.silenet_errors
+    @silent_errors.nil? ? false : @silent_errors
+  end
+
+  def self.callback_url
+    @callback_url || 'urn:ietf:wg:oauth:2.0:oob'
+  end
+
+  def self.authorization_url
+    client.authorization_url
+  end
+
+  # Request Access Token
+  # credentials should be key/values based on grant type
+  # grant :code should include :authorization_code
+  # grant :password should include :username and :password
+  def self.authorize(credentials)
+    client.authorize(credentials)
+  end
+
+  def self.access_token
+    client.access_token.token
+  end
+
+  private
+
+  def self.client
+    @client ||= KetraClient.new
+  end
+  
+
+  
+  
+end

data/lib/ketra/ketra_client.rb

@@ -0,0 +1,33 @@
+module Ketra
+  class KetraClient
+
+    attr_accessor :access_token
+
+    # Authorization
+
+    def authorization_url
+      unless Ketra.authorization_grant == :code
+        raise(NotImplementedError, "authorization url is only for grant type :code")
+      end
+      client.auth_code.authorize_url(:redirect_uri => Ketra.callback_url)
+    end
+
+    def authorize(credentials)
+      case Ketra.authorization_grant
+      when :code
+        @access_token ||= client.auth_code.get_token(credentials[:authorization_code], :redirect_uri => Ketra.callback_url)
+      when :password
+        @access_token ||= client.password.get_token(credentials[:username], credentials[:password])
+      end
+    end
+    
+    private
+
+    def client
+      @client ||= OAuth2::Client.new(Ketra.client_id,
+                                     Ketra.client_secret,
+                                     :site => Ketra.host)
+    end
+    
+  end
+end

data/lib/ketra/ketra_client.rb~

@@ -0,0 +1,24 @@
+module Ketra
+  class KetraClient
+
+    
+    
+
+    # Authorization
+
+    def authorization_url
+      unless authorization_grant == 'implicit'
+        raise(NotImplementedError, "authorization url is only for grant type :implicit")
+      end
+      client.implicit.authorize_url(:redirect_uri => callback_url)
+    end
+    
+
+    private
+
+    def client
+      @client ||= OAuth2::Client.new(client_id, client_secret, :site => host)
+    end
+    
+  end
+end

data/lib/ketra/version.rb

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

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: ketra
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kenneth Priester
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !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: 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'
+description: A friendly Ruby interface to the Ketra API
+email:
+- kennethjpriester@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
+- ketra.gemspec
+- lib/ketra.rb
+- lib/ketra/ketra_client.rb
+- lib/ketra/ketra_client.rb~
+- lib/ketra/version.rb
+homepage: http://github.com/kennyjpowers/ketra
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Provides a friendly ruby-like wrapper for the Ketra API
+test_files: []