respoke 1.1.3

data/lib/respoke/errors.rb

@@ -0,0 +1,9 @@
+
+module Respoke
+  # Contains custom error classes for better raises and error logging.
+  module Errors
+      # A catch all error for unspecified server errors.
+    class UnexpectedServerError < StandardError
+    end
+  end
+end

data/lib/respoke/response.rb

@@ -0,0 +1,9 @@
+
+require 'respoke/response/session_token'
+require 'respoke/response/session_token_id'
+
+module Respoke
+  # Contains various response classes to use as return values for API requests.
+  module Response
+  end
+end

data/lib/respoke/response/session_token.rb

@@ -0,0 +1,12 @@
+require 'hashie'
+
+module Respoke
+  module Response
+    # A response object for session token requests.
+    #
+    # @attr token [String] The token for use as an App-Token.
+    # @attr message [String] Token request status information.
+    class SessionToken < Hashie::Mash
+    end
+  end
+end

data/lib/respoke/response/session_token_id.rb

@@ -0,0 +1,27 @@
+require 'hashie'
+
+module Respoke
+  module Response
+    # A response object for token requests.
+    #
+    # @attr tokenId [String] Token ID used to request an App-Token.
+    # @attr appId [String] App ID App-Token is associated with.
+    # @attr roleId [String] Role ID App-Token is assigned.
+    # @attr endpointId [String] Endpoint ID App-Token is for.
+    # @attr ttl [Number] Number of seconds App-Token is valid for.
+    # @attr createdAt [DateTime] When the token request was made.
+    # @attr expiryTime [DateTime] When the token expires.
+    # @attr createTime [DateTime] When the token was created.
+    class SessionTokenId < Hashie::Mash
+      include Hashie::Extensions::Coercion
+
+      coerce_key :createdAt, ->(time) do
+        Time.parse(time).getutc
+      end
+
+      coerce_key :expiryTime, :createTime, ->(timestamp) do
+        Time.at(timestamp).getutc
+      end
+    end
+  end
+end

data/lib/respoke/role.rb

@@ -0,0 +1,20 @@
+module Respoke
+  class Role
+    attr_reader :id, :name
+    attr_accessor :rules
+    def initialize(client, id:, name:, **rules)
+      @client = client
+      @id = id
+      @name = name
+      @rules = rules
+    end
+
+    def save
+      response = @client.update_role(id: @id, rules: @rules)
+    end
+
+    def delete
+      response = @client.delete_role(id: @id)
+    end
+  end
+end

data/lib/respoke/version.rb

@@ -0,0 +1,4 @@
+module Respoke
+  # gem version number
+  VERSION = "1.1.3"
+end

data/respoke.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'respoke/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'respoke'
+  spec.version       = Respoke::VERSION
+  spec.date          = Time.now.strftime('%Y-%m-%d')
+  spec.authors       = ['Matthew Turney']
+  spec.email         = ['mturney@respoke.io']
+  spec.summary       = %q{Wrapper library for the Respoke API.}
+  spec.homepage      = 'https://respoke.io'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^test/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '~> 0.9'
+  spec.add_dependency 'faraday_middleware', '~> 0.9'
+  spec.add_dependency 'hashie', '~> 3.3.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-reporters'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'ruby-lint'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'timecop'
+end

data/test/spec/brokered_auth_spec.rb

@@ -0,0 +1,89 @@
+require 'test_helper'
+
+describe 'Brokered authentication' do
+  subject { client }
+
+  describe 'when using App-Secret' do
+    let :client do
+      Respoke::Client.new(app_secret: TestConfig.app_secret)
+    end
+
+    it 'requests token ID' do
+      response = nil
+
+      VCR.use_cassette 'session_token_id_request' do
+        response = subject.request_session_token_id(
+          appId: TestConfig.app_id,
+          endpointId: 'foo-bar',
+          roleId: TestConfig.role_id,
+          ttl: 60
+        )
+      end
+
+      assert response.tokenId?
+    end
+
+    describe 'and already given a session token ID' do
+      let :token_id do
+        token_id = ''
+
+        VCR.use_cassette 'session_token_id_request' do
+          token_id = subject.request_session_token_id(
+            appId: TestConfig.app_id,
+            endpointId: 'foo-bar',
+            roleId: TestConfig.role_id,
+            ttl: 60 # this is short since it's only needed in the test
+          ).tokenId
+        end
+
+        token_id
+      end
+
+      it 'requests App-Token using session token ID' do
+        response = nil
+
+        VCR.use_cassette 'session_token_request' do
+          response = subject.request_session_token(
+            appId: TestConfig.app_id,
+            tokenId: token_id,
+          )
+        end
+
+        assert response.token?
+      end
+    end
+
+    it 'requests an App-Token in one step' do
+      token = ''
+
+      VCR.use_cassette 'app_token_request' do
+        token = subject.app_token(
+          appId: TestConfig.app_id,
+          endpointId: 'foo-bar',
+          roleId: TestConfig.role_id,
+          ttl: 60
+        )
+      end
+
+      assert_instance_of String, token
+      refute_equal '', token
+    end
+
+    describe 'when App-Token has already been set' do
+      before do
+        VCR.use_cassette 'app_token_request' do
+          @expected_app_token = subject.app_token(
+            appId: TestConfig.app_id,
+            endpointId: 'foo-bar',
+            roleId: TestConfig.role_id,
+            ttl: 60
+          )
+        end
+      end
+
+      it 'returns that token' do
+        assert_equal @expected_app_token, subject.app_token
+      end
+    end
+  end
+end

data/test/spec/role_spec.rb

@@ -0,0 +1,44 @@
+
+require 'test_helper'
+
+
+describe "Roles" do
+  let :client do
+    Respoke::Client.new(app_secret: TestConfig.app_secret)
+  end
+
+  let :existing_role do
+    client.create_role(name: SecureRandom::uuid(), rules: {})
+  end
+
+  it "creates a role" do
+    VCR.use_cassette 'create_role' do
+      role_name = SecureRandom::uuid()
+      role = client.create_role(name: role_name, rules: { mediaRelay: false })
+      assert !role.id.nil?
+    end
+  end
+
+  it "finds a role" do
+    VCR.use_cassette 'find_role' do
+      response = client.find_role(id: existing_role.id)
+      assert (response.name == existing_role.name) && (existing_role.id == existing_role.id)
+    end
+  end
+
+  it "updates a role" do
+    VCR.use_cassette 'update_role' do
+      assert existing_role.rules[:mediaRelay] == false
+      existing_role.rules[:mediaRelay]=true
+      existing_role.save
+      assert (client.find_role(id: existing_role.id).rules[:mediaRelay] == true)
+    end
+  end
+
+  it "deletes a role" do
+    VCR.use_cassette 'delete_a_role' do
+      existing_role.delete
+      assert client.find_role(id: existing_role.id).nil?
+    end
+  end
+end

data/test/test_config.example.yml

@@ -0,0 +1,6 @@
+# values to be used in specs, these should be real working values from the
+# Developer Portal
+
+app_secret: <app-secret-token>
+app_id: <app-id>
+role_id: <role-id>

data/test/test_helper.rb

@@ -0,0 +1,26 @@
+require 'json'
+require 'yaml'
+require 'hashie'
+require 'vcr'
+
+require 'minitest/autorun'
+require 'minitest/reporters'
+
+require 'simplecov' if ENV["COVERAGE"]
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'respoke'
+
+Minitest::Reporters.use! [Minitest::Reporters::SpecReporter.new]
+
+TestConfig = Hashie::Mash.load(File.expand_path('test_config.yml', __dir__))
+
+VCR.configure do |config|
+  # Due to a bug in VCR faraday middleware we must use webmock. A fix has been
+  # merged (https://github.com/vcr/vcr/pull/439) but it does not have a tagged
+  # release yet.
+  config.hook_into :webmock
+  config.cassette_library_dir = 'test/vcr_cassettes'
+  config.default_cassette_options = { :record => :once }
+  config.filter_sensitive_data('<APP_SECRET>') { TestConfig.app_secret }
+end

data/test/unit/client_test.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+
+class Respoke::TestClient < MiniTest::Test
+  def setup
+    @client = Respoke::Client.new
+  end
+
+  def test_can_create_new_client
+    assert_instance_of Respoke::Client, @client
+  end
+
+  def test_can_set_app_secret_on_initialization
+    secret = 'foo'
+    client = Respoke::Client.new(app_secret: secret)
+
+    assert_equal secret, client.app_secret
+  end
+
+  def test_cannot_set_app_secret_by_attribute
+    secret = 'foo'
+
+    assert_raises NoMethodError do
+      @client.app_secret = secret
+    end
+  end
+
+  def test_has_default_base_url
+    assert_equal Respoke::Client::DEFAULT_BASE_URL, @client.base_url
+  end
+
+  def test_can_override_base_url
+    url = 'https://localhost:2000'
+    client = Respoke::Client.new(base_url: url)
+
+    assert_equal url, client.base_url
+  end
+
+  def test_cannot_set_base_url_by_attribute
+    assert_raises NoMethodError do
+      @client.base_url = 'https://localhost:2000'
+    end
+  end
+end

data/test/unit/respoke_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class TestRespoke < MiniTest::Test
+  def test_that_it_has_a_version_number
+    refute_nil ::Respoke::VERSION
+  end
+end

data/test/unit/response/session_token_id_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+class Respoke::Response::TestSessionTokenId < Minitest::Test
+  def setup
+    @klass = Respoke::Response::SessionTokenId
+  end
+
+  def test_can_create_new_instance
+    response = @klass.new
+
+    assert_instance_of @klass, response
+  end
+
+  def test_coerces_createdAt_to_utc_Time
+    response = @klass.new(
+      createdAt: '2015-01-02T21:30:57.714Z'
+    )
+
+    assert_instance_of Time, response.createdAt
+    assert response.createdAt.utc?
+  end
+
+  def test_coerces_expiryTime_to_utc_Time
+    response = @klass.new(
+      expiryTime: 1420320657
+    )
+
+    assert_instance_of Time, response.expiryTime
+    assert response.expiryTime.utc?
+  end
+
+  def test_coerces_createTime_to_utc_Time
+    response = @klass.new(
+      createTime: 1420320657
+    )
+
+    assert_instance_of Time, response.createTime
+    assert response.createTime.utc?
+  end
+end

data/test/unit/response/session_token_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class Respoke::Response::TestSessionToken < Minitest::Test
+  def test_can_create_new_instance
+    instance = Respoke::Response::SessionToken.new
+
+    assert_instance_of Respoke::Response::SessionToken, instance
+  end
+end

data/test/vcr_cassettes/app_token_request.yml

@@ -0,0 +1,99 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.respoke.io/v1/tokens
+    body:
+      encoding: UTF-8
+      string: '{"appId":"0dfcfe78-c4af-497f-88f6-c6b3a8151fb3","endpointId":"foo-bar","roleId":"56BD864A-3474-4D41-A3E7-1577078B63D5","ttl":86400}'
+    headers:
+      App-Secret:
+      - "<APP_SECRET>"
+      User-Agent:
+      - Faraday v0.9.0
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Fri, 02 Jan 2015 21:30:58 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Vary:
+      - Accept-Encoding
+      - Accept-Encoding
+      Request-Id:
+      - 5b39afb9-c629-434f-861e-aadc75319f4b
+      Ratelimit-Limit:
+      - '10'
+      Ratelimit-Time-Units:
+      - seconds
+      Ratelimit-Remaining:
+      - '7'
+    body:
+      encoding: UTF-8
+      string: '{"appId":"0dfcfe78-c4af-497f-88f6-c6b3a8151fb3","endpointId":"foo-bar","roleId":"56BD864A-3474-4D41-A3E7-1577078B63D5","accountId":"9628FFD0-54E8-402C-A979-368B03EC63D9","createTime":1420234258,"expiryTime":1420320658,"id":"E44902BA-639B-4EAD-9C88-CD846146BB19","forDevelopment":false,"createdAt":"2015-01-02T21:30:58.539Z","tokenId":"E44902BA-639B-4EAD-9C88-CD846146BB19"}'
+    http_version: 
+  recorded_at: Fri, 02 Jan 2015 21:30:58 GMT
+- request:
+    method: post
+    uri: https://api.respoke.io/v1/session-tokens
+    body:
+      encoding: UTF-8
+      string: '{"appId":"0dfcfe78-c4af-497f-88f6-c6b3a8151fb3","tokenId":"E44902BA-639B-4EAD-9C88-CD846146BB19"}'
+    headers:
+      App-Secret:
+      - "<APP_SECRET>"
+      User-Agent:
+      - Faraday v0.9.0
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Fri, 02 Jan 2015 21:30:58 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Vary:
+      - Accept-Encoding
+      - Accept-Encoding
+      Request-Id:
+      - 9a985440-76b2-4e83-9528-ddf22414e1cf
+      Ratelimit-Limit:
+      - '10'
+      Ratelimit-Time-Units:
+      - seconds
+      Ratelimit-Remaining:
+      - '6'
+    body:
+      encoding: UTF-8
+      string: '{"message":"Authorization successful","token":"1834AD29-F08B-43F7-91F1-52EF33814589"}'
+    http_version: 
+  recorded_at: Fri, 02 Jan 2015 21:30:58 GMT
+recorded_with: VCR 2.9.3