respoke 1.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 196657fbadbddac896125b5633e9a41ddc6ba4b5
+  data.tar.gz: ee0fd8872889c7868049130640092baa13f34294
+SHA512:
+  metadata.gz: 15c8773001b7e574b8841fbb58190067f2d97f46a7b55be273ef008710d8b4210c4c2b4e323b100c4948952ec70d75dfa43cde995026e8fea51ee95cb8432926
+  data.tar.gz: 8380b37f0d43ffd581d77389d8f5cbb6fbe8eb89c23283e85810102013ab09197e5eb2fbc41969b2ed77e209c0b292786d0f323a607786b743c4f0feaba0c307

data/.editorconfig

@@ -0,0 +1,17 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+max_line_length = 80
+
+# Set default charset
+[*.{rb,gemspec}, Gemfile]
+charset = utf-8
+indent_style = space
+indent_size = 2

data/.gitignore

@@ -0,0 +1,7 @@
+Gemfile.lock
+.bundle
+coverage
+doc
+.yardoc
+test/test_config*.yml
+!test/test_config.example.yml

data/.simplecov

@@ -0,0 +1,6 @@
+
+SimpleCov.start do
+  add_filter '/test/'
+  add_filter '.bundle'
+  add_filter 'coverage'
+end

data/.travis.yml

@@ -0,0 +1,17 @@
+script: bundle exec rake test
+rvm:
+- 2.1
+notifications:
+  email:
+    recipients:
+    - monitoring@respoke.io
+    email:
+      on_success: change
+      on_failure: always
+cache: bundler
+os:
+  - linux
+  - osx
+before_install:
+- openssl aes-256-cbc -K $encrypted_4e4ac21e4bd9_key -iv $encrypted_4e4ac21e4bd9_iv
+  -in test/test_config.yml.enc -out test/test_config.yml -d

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Digium, Inc.
+
+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,93 @@
+[![Gem Version](https://badge.fury.io/rb/respoke.svg)](http://badge.fury.io/rb/respoke)
+[![Build Status](https://travis-ci.org/pho3nixf1re/ruby-respoke.svg?branch=master)](https://travis-ci.org/pho3nixf1re/ruby-respoke)
+[![Dependency Status](https://gemnasium.com/pho3nixf1re/ruby-respoke.svg)](https://gemnasium.com/pho3nixf1re/ruby-respoke)
+
+# Respoke
+
+ruby-respoke is a wrapper for the Respoke API. For more information on the
+Respoke service and API see [docs.respoke.io](http://docs.respoke.io).
+
+## Installation
+
+Using bundler, add this line to your application's Gemfile:
+
+```ruby
+gem 'respoke'
+```
+
+And then execute:
+
+    $ bundle
+
+For details on the ruby-respoke API please refer to the [full documentation].
+
+[full documentation]: http://www.rubydoc.info/github/pho3nixf1re/ruby-respoke/master
+
+## Running the tests
+
+The test suite uses VCR to record API requests and responses once. After the
+first run it caches these and works offline. These cached files are checked into
+Git and can be found in the `test/vcr_cassettes` directory. To run the tests
+against the live API just delete the `test/vcr_cassettes` directory. Please note
+that this will change the expected input of the encrypted
+`test/test_config.yml.enc` file used by Travis and that will need to be updated
+if you intend to commit the new VCR cache. Otherwise just omit the new cache
+files when making your tests.
+
+### Units
+
+Note that the unit tests do not use the VCR cache in favor of stubbing.
+
+```sh
+rake test:unit
+```
+
+### Specs
+
+Before you can run the specs yourself you will need to remove the VCR cache
+files and provide your Respoke API credentials. Copy the `test/test_config.yml`
+file and replace the example values with the ones in the Respoke
+[developer portal].
+
+[developer portal]: https://portal.respoke.io
+
+```
+cp test/test_config.example.yml test/test_config.yml
+```
+
+Fill in the test_config.yml values then run the spec rake task.
+
+```sh
+rake test:spec
+```
+
+## Building the documentation
+
+The documentation is marked up using Yard + Markdown. The easiest way to build
+the included docs is to use the rake task.
+
+```sh
+rake yard
+```
+
+## Contributing
+
+If you wish to submit an issue use the [issue tracker].
+
+[issue tracker]: https://github.com/pho3nixf1re/ruby-respoke/issues
+
+1. Fork it ( https://github.com/[my-github-username]/ruby-respoke/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
+
+## License
+
+Copyright 2014, Digium, Inc.
+All rights reserved.
+
+This source code is licensed under The MIT License found in the
+[LICENSE](LICENSE) file in the root directory of this source tree.
+
+For all details and documentation:  https://www.respoke.io

data/Rakefile

@@ -0,0 +1,32 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require 'yard'
+require 'bundler/version'
+
+namespace :test do
+  Rake::TestTask.new(:spec) do |t|
+    t.libs << "test"
+    t.test_files = FileList['test/spec/*_spec.rb']
+  end
+
+  Rake::TestTask.new(:unit) do |t|
+    t.libs << "test"
+    t.test_files = FileList['test/unit/**/*_test.rb']
+  end
+end
+
+task :test => ['test:spec', 'test:unit']
+
+task :default => :test
+
+YARD::Rake::YardocTask.new do |t|
+  t.options = ['-m', 'markdown']
+end
+
+task :build do
+  system "gem build respoke.gemspec"
+end
+
+task :release => :build do
+  system "gem push respoke-#{Respoke::VERSION}.gem"
+end

data/lib/respoke.rb

@@ -0,0 +1,7 @@
+require "respoke/version"
+require "respoke/client"
+require "respoke/role"
+
+# The respoke gem top level namespace.
+module Respoke
+end

data/lib/respoke/client.rb

@@ -0,0 +1,265 @@
+require 'faraday'
+require 'faraday_middleware'
+
+require 'respoke/errors'
+require 'respoke/response'
+
+# Contains methods to make API calls.
+#
+# @example One-step endpoint authentication
+#
+#   require 'respoke'
+#
+#   client = Respoke::Client.new(app_secret: '77269d84-d7f3-49da-8eab-bd6686160035')
+#   client.app_token(
+#     appId: '0cdf7bc1-45d1-420a-963e-c797a6f7ba61',
+#     roleId: '47ea573f-5a78-42f4-927c-fe658bc00f91',
+#     endpointId: 'foo-bar-user'
+#   )
+#   #=> '3c022dbd-0a82-4382-bd0d-5af6e11b8d67'
+#
+# @example Manual endpoint authentication
+#
+#     require 'respoke'
+#
+#     client = Respoke::Client.new(app_secret: '77269d84-d7f3-49da-8eab-bd6686160035')
+#
+#     session_id_response = client.request_session_token_id(
+#       appId: '0cdf7bc1-45d1-420a-963e-c797a6f7ba61',
+#       roleId: '47ea573f-5a78-42f4-927c-fe658bc00f91',
+#       endpointId: 'foo-bar-user'
+#     )
+#     session = client.request_session_token(
+#       appId: session_id_response.appId,
+#       tokenId: session_id_response.tokenId
+#     )
+#
+#     session.token #=> '3c022dbd-0a82-4382-bd0d-5af6e11b8d67'
+#
+#     # OR you can just use Client#app_token since Client#request_session_token
+#     # sets `@app_token`.
+#     client.app_token #=> '3c022dbd-0a82-4382-bd0d-5af6e11b8d67'
+#
+# @attr_reader app_token
+#
+class Respoke::Client
+
+  # Default base_url
+  DEFAULT_BASE_URL = 'https://api.respoke.io/v1'
+
+  # Base URL used for API requests
+  attr_reader :base_url
+
+  # Sets the App-Secret token
+  attr_reader :app_secret
+
+  # Creates a new Client instance.
+  #
+  # @param app_secret [String] The application App-Secret token.
+  #   (Defaults to nil)
+  # @param base_url [String] Overrides the {DEFAULT_BASE_URL} constant.
+  #   (Defaults to {DEFAULT_BASE_URL})
+  #
+  # @return [Respoke::Client]
+  def initialize(app_secret: nil, base_url: DEFAULT_BASE_URL)
+    @base_url = base_url
+    @app_secret = app_secret
+  end
+
+  # Either returns the current `@app_token` or sets it based on the parameter
+  # Hash `token_request_params`.
+  #
+  # @param token_request_params [Hash] parameters for
+  #   {#request_session_token_id}.
+  # @option token_request_params [String] appId The application ID.
+  # @option token_request_params [String] roleId Role ID to use for permissions
+  #   on given endpoint ID.
+  # @option token_request_params [String] endpointId The endpoint ID to
+  #   authenticate.
+  # @option token_request_params [Number] ttl (86400) Length of time token is
+  #   valid.
+  #
+  # @return [String] App-Token value.
+  def app_token(token_request_params={})
+    @app_token ||= (
+      if token_request_params
+        response = request_session_token_id(token_request_params)
+        request_session_token(
+          appId: response.appId,
+          tokenId: response.tokenId
+        ).token
+      end
+    )
+  end
+
+  # Request a token ID for use in requesting the App-Token value.
+  #
+  # @todo test return value
+  #
+  # @param appId [String] The application ID that matches the App-Secret.
+  # @param roleId [String] The role ID to use for the given endpoint.
+  # @param endpointId [String] The endpoint ID that is being authenticated.
+  # @param ttl [Number] The amount of time in seconds the App-Token is
+  #   valid. (Defaults to 86400)
+  #
+  # @return [Respoke::Response::SessionTokenId] The API response object.
+  def request_session_token_id(appId:, roleId:, endpointId:, ttl: 86400)
+    response = connection.post 'tokens' do |request|
+      request.body = {
+        appId: appId,
+        endpointId: endpointId,
+        roleId: roleId,
+        ttl: 86400
+      }
+    end
+
+    if response.status != 200
+      raise Respoke::Errors::UnexpectedServerError, <<-ERR
+        request failed with status #{response.status}:
+        #{response.body}
+      ERR
+    else
+      Respoke::Response::SessionTokenId.new(response.body)
+    end
+  end
+
+  # Request the session token using the tokenId retrived with
+  # {#request_session_token_id}. This method sets the `app_token` attribute.
+  #
+  # @todo test setting of `@app_token`.
+  #
+  # @param appId [String] The application ID used in the token request.
+  # @param tokenId [String] The token ID requested from
+  #   {#request_session_token_id}.
+  #
+  # @return [Respoke::Response::SessionToken] The API response object.
+  def request_session_token(appId:, tokenId:)
+    response = connection.post 'session-tokens' do |request|
+      request.body = {
+        appId: appId,
+        tokenId: tokenId
+      }
+    end
+    @app_token = response.body.fetch('token', nil)
+
+    if response.status != 200
+      raise Respoke::Errors::UnexpectedServerError, <<-ERR
+        request failed with status #{response.status}:
+        #{response.body}
+      ERR
+    else
+      Respoke::Response::SessionToken.new(response.body)
+    end
+  end
+
+  # Get the roles
+  #
+  # @return [Array<Respoke::Role>]  An array of role objects
+  # @raise [Respoke::Errors::UnexpectedServerError] if errors occur
+  def roles()
+    response = connection.get 'roles'
+
+    if response.status != 200
+      raise Respoke::Errors::UnexpectedServerError, <<-ERR
+        request failed with status #{response.status}:
+        #{response.body}
+      ERR
+    else
+      response.body.map { |r| Respoke::Role.new(connection, r.each_with_object({}) { |(k,v), h| h[k.to_sym] = v} ) }
+    end
+  end
+
+  # Create a role
+  #
+  # @param name [String]  The name of the role
+  # @param rules [Hash]  The permissions for the role
+  #
+  # @return [Respoke::Role]  The role that was created
+  # @raise [Respoke::Errors::UnexpectedServerError] if errors occur
+  def create_role(name:, rules: {})
+    response = connection.post 'roles' do |request|
+      request.body = rules.merge( name: name )
+    end
+
+    if response.status != 200
+      raise Respoke::Errors::UnexpectedServerError, <<-ERR
+        request failed with status #{response.status}:
+        #{response.body}
+      ERR
+    else
+      Respoke::Role.new(self, response.body.each_with_object({}) { |(k,v), h| h[k.to_sym] = v} )
+    end
+  end
+
+
+  # Find a role
+  #
+  # @param id [String]  The id of the role to retrieve
+  #
+  # @return [Respoke::Role]  The role that was retrieved, nil if none found
+  # @raise [Respoke::Errors::UnexpectedServerError] if errors occur
+  def find_role(id:)
+    response = connection.get "roles/#{id}"
+
+    if response.status == 404
+      nil
+    elsif !response.success?
+      raise Respoke::Errors::UnexpectedServerError, <<-ERR
+        request failed with status #{response.status}:
+        #{response.body}
+      ERR
+    else
+      Respoke::Role.new(self, response.body.each_with_object({}) { |(k,v), h| h[k.to_sym] = v} )
+    end
+  end
+
+  # Update a role
+  #
+  # @param id [String]    The id of the role to update
+  # @param rules [Hash]   The new permissions for the role
+  #
+  # @return [Boolean]     true if successfully updated
+  # @raise [Respoke::Errors::UnexpectedServerError] if errors occur
+  def update_role(id:, rules:)
+    response = connection.put "roles/#{id}" do |request|
+      request.body = rules
+    end
+
+    if !response.success?
+      raise Respoke::Errors::UnexpectedServerError, <<-ERR
+        request failed with status #{response.status}:
+        #{response.body}
+      ERR
+    else
+      true
+    end
+  end
+
+  # Delete a role
+  #
+  # @param id [String]  The id of the role to retrieve
+  #
+  # @return [Boolean]  true if the role was deleted, false otherwise
+  def delete_role(id:)
+    response = connection.delete "roles/#{id}"
+    response.success?
+  end
+
+  private
+
+  # Creates a Faraday connection object to make requests with.
+  #
+  # @return [Faraday::Connection] The connection object for making API requests.
+  def connection
+    @connection ||= Faraday.new(
+      url: @base_url,
+      headers: { :'App-Secret' => @app_secret }
+    ) do |faraday|
+      faraday.request :json
+
+      faraday.response :json, :content_type => 'application/json'
+
+      faraday.adapter Faraday.default_adapter
+    end
+  end
+end