vhx-ruby 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: beb4e508443c33c4e403dc3af8968963b782b16d
+  data.tar.gz: 252a387534bc8e8eb38c6e9189cac2a6e9e501a1
+SHA512:
+  metadata.gz: 6e06429c037251651ce2b8ccb192f5e04f46dd0e6311e9c77282841799ad0997de16482be0db7f390b8eee227df018d4de512f149f3616f63357b6b7cc54a5d2
+  data.tar.gz: bbe96986befef7b8b2679d51e8c4f4a6d51207402a29a5fd237c6b93ad4ffb66ff64b6f0753e273802c1a8234cfa0781328991a07419c9268f87ae41bd865c49

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+.bundle
+.config
+Gemfile.lock
+doc/
+test/tmp
+test/version_tmp
+tmp
+.tddium*
+.idea
+.DS_Store

data/.rspec

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

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,59 @@
+# VHX Ruby API Client
+
+The VHX API is currently Private Beta. You can request an API key by emailing api@vhx.tv.
+
+### Installation
+
+`gem install vhx-ruby`
+
+### Documentation
+
+Documentation is available at http://dev.vhx.tv/docs/api/ruby.
+Full API reference is available at http://dev.vhx.tv/docs/api?ruby.
+
+## Getting Started
+
+Before requesting your first resource, you must setup an instance of the Vhx Client:
+
+```ruby
+vhx = Vhx.setup({ api_key: 'your VHX API key'} )
+```
+
+Here's an example of creating a Vhx resource with payload options. You can handle errors by rescuing Vhx::VhxError. 
+
+```ruby
+begin
+  # Example Customer Create
+  customer = Vhx::Customer.create({
+    email: 'customer@email.com',
+    name: 'First Last',
+    subscription: 'https://api.vhx.tv/subscriptions/1'
+  })
+rescue Vhx::VhxError
+  # Handle error
+end
+```
+
+### Resources & methods
+
+ customers
+  * [`create`](http://dev.vhx.tv/docs/api?ruby#create_customer)
+  * [`update`](http://dev.vhx.tv/docs/api?ruby#update_customer)
+  * [`retrieve`](http://dev.vhx.tv/docs/api?ruby#retrieve_customer)
+  * [`list`](http://dev.vhx.tv/docs/api?ruby#list_customers)
+
+authorizations
+  * [`create`](http://dev.vhx.tv/docs/api?ruby#create_authorization)
+
+videos
+  * [`create`](http://dev.vhx.tv/docs/api?ruby#create_customer)
+  * [`update`](http://dev.vhx.tv/docs/api?ruby#update_customer)
+  * [`retrieve`](http://dev.vhx.tv/docs/api?ruby#retrieve_customer)
+  * [`list`](http://dev.vhx.tv/docs/api?ruby#list_customers)
+
+collections
+  * [`create`](http://dev.vhx.tv/docs/api?ruby#create_collection)
+  * [`update`](http://dev.vhx.tv/docs/api?ruby#update_collection)
+  * [`retrieve`](http://dev.vhx.tv/docs/api?ruby#retrieve_collection)
+  * [`list`](http://dev.vhx.tv/docs/api?ruby#list_collections)
+  * [`items`](http://dev.vhx.tv/docs/api?ruby#list_collection_items)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/vhx.rb

@@ -0,0 +1,66 @@
+require 'faraday'
+require 'faraday_middleware'
+
+require "vhx/version"
+require "vhx/error"
+require "vhx/oauth_token"
+
+require 'vhx/middleware/error_response'
+require 'vhx/middleware/oauth2'
+
+require "vhx/client"
+
+require "vhx/utilities/vhx_helper"
+require "vhx/utilities/api_operations/create"
+require "vhx/utilities/api_operations/delete"
+require "vhx/utilities/api_operations/list"
+require "vhx/utilities/api_operations/request"
+require "vhx/utilities/api_operations/update"
+
+require "vhx/utilities/vhx_object"
+require "vhx/utilities/vhx_list_object"
+
+require "vhx/objects/user"
+require "vhx/objects/collection"
+require "vhx/objects/collection_item"
+require "vhx/objects/product"
+require "vhx/objects/site"
+require "vhx/objects/video"
+require "vhx/objects/video_file"
+require "vhx/objects/customer"
+require "vhx/objects/authorization"
+
+module Vhx
+  API_BASE_URL = 'https://api.vhx.tv'
+
+  class << self
+    def setup(options = {})
+      options[:client_id]         ||= @client_id
+      options[:client_secret]     ||= @client_secret
+      options[:api_key]           ||= @api_key
+      options[:api_base]          ||= @api_base_url
+      options[:skip_auto_refresh]   = @skip_auto_refresh if options[:skip_auto_refresh].nil?
+      Vhx.client = Vhx::Client.new(options)
+    end
+
+    def config(config = {})
+      @client_id          = config[:client_id]
+      @client_secret      = config[:client_secret]
+      @api_key            = config[:api_key]
+      @skip_auto_refresh  = config[:skip_auto_refresh] || false
+      @api_base_url       = config[:api_base]
+    end
+
+    def client
+      @client
+    end
+
+    def client=(new_client)
+      @client = new_client
+    end
+
+    def connection
+      client ? client.connection : nil
+    end
+  end
+end

data/lib/vhx/client.rb

@@ -0,0 +1,86 @@
+module Vhx
+  class Client
+    attr_reader :client_id, :client_secret, :api_base_url, :oauth_token, :api_key, :connection, :ssl
+
+    def initialize(options = {})
+      options            = Hash[options.map{ |k, v| [k.to_sym, v] }]
+      @api_base_url      = options[:api_base] || API_BASE_URL
+      @client_id         = options[:client_id]
+      @client_secret     = options[:client_secret]
+      @oauth_token       = options[:api_key] ? nil : OAuthToken.new(options, refreshed = false)
+      @api_key           = options[:api_key]
+      @skip_auto_refresh = options[:skip_auto_refresh]
+      @ssl               = options[:ssl] || {}
+      @headers           = {}
+
+      configure_connection
+    end
+
+    def configure_connection
+      @connection = Faraday::Connection.new(url: api_base_url, headers: configured_headers, ssl: ssl) do |faraday|
+        faraday.request  :url_encoded
+        faraday.request  :json
+        faraday.response :logger
+        faraday.use Vhx::Middleware::OAuth2, :vhx_client => self unless @skip_auto_refresh
+
+        faraday.adapter Faraday.default_adapter
+
+        faraday.use Vhx::Middleware::ErrorResponse
+        faraday.response :json
+      end
+      @connection
+    end
+
+    def configured_headers
+      if access_token
+        @headers[:Authorization] = "Bearer #{access_token}"
+      elsif api_key
+        @headers[:Authorization] = Faraday::Request::BasicAuthentication.header(api_key, '')
+      end
+
+      @headers
+    end
+
+    def access_token
+      unless oauth_token
+        return nil
+      end
+
+      oauth_token.access_token
+    end
+
+    def expired?
+      unless oauth_token
+        return false
+      end
+
+      oauth_token.expires && oauth_token.expires_at < Time.now.to_i
+    end
+
+    def credentials
+      unless oauth_token
+        return nil
+      end
+
+      oauth_token.to_h
+    end
+
+    def refresh_access_token!
+      conn = @connection.dup
+      conn.headers.delete(:Authorization)
+      response = conn.post do |req|
+        req.url '/oauth/token'
+        req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+        req.body = {
+          grant_type:    'refresh_token',
+          refresh_token: oauth_token.refresh_token,
+          client_id:     client_id,
+          client_secret: client_secret
+        }
+      end
+      @oauth_token = OAuthToken.new(response.body, refreshed = true)
+
+      configure_connection
+    end
+  end
+end

data/lib/vhx/error.rb

@@ -0,0 +1,24 @@
+module Vhx
+  class VhxError < StandardError
+    attr_reader :response_body, :response_status, :url, :message
+
+    def initialize(response_body, response_status, url)
+      @response_body   = response_body
+      @response_status = response_status
+      @url             = url
+      @message         = response_body.is_a?(Hash) ? response_body['message'] : response_body.to_s
+
+      super(@message)
+    end
+  end
+
+  class BadRequestError < VhxError; end
+  class UnauthorizedError < VhxError; end
+  class InvalidTokenError < VhxError; end
+  class PaymentRequiredError < VhxError; end
+  class NotFoundError < VhxError; end
+  class NotAcceptableError < VhxError; end
+  class ServerError < VhxError; end
+
+  class InvalidResourceError < StandardError; end
+end

data/lib/vhx/middleware/error_response.rb

@@ -0,0 +1,32 @@
+module Vhx
+  module Middleware
+    class ErrorResponse < Faraday::Response::Middleware
+      def on_complete(env)
+        error_class = case env[:status]
+        when 200, 201, 204
+        when 304
+        when 400
+          BadRequestError
+        when 401
+          if env[:body].fetch('message', '').match(/token/)
+            InvalidTokenError
+          else
+            UnauthorizedError
+          end
+        when 402
+          PaymentRequiredError
+        when 404
+          NotFoundError
+        when 406
+          NotAcceptableError
+        else
+          ServerError
+        end
+
+        if error_class
+          raise error_class.new(env[:body], env[:status], env[:url])
+        end
+      end
+    end
+  end
+end

data/lib/vhx/middleware/oauth2.rb

@@ -0,0 +1,22 @@
+module Vhx
+  module Middleware
+    class OAuth2 < Faraday::Middleware
+      def call(env)
+        orig_env = env.dup
+
+        begin
+          @app.call(env)
+        rescue InvalidTokenError
+          @vhx_client.refresh_access_token!
+          orig_env[:request_headers].merge!(@vhx_client.configured_headers)
+          @app.call(orig_env)
+        end
+      end
+
+      def initialize(app, options={})
+        super(app)
+        @vhx_client = options[:vhx_client]
+      end
+    end
+  end
+end

data/lib/vhx/oauth_token.rb

@@ -0,0 +1,11 @@
+class OAuthToken < Struct.new(:access_token, :refresh_token, :expires_at, :expires_in, :expires, :refreshed)
+  def initialize(params = {}, refreshed = false)
+    params             = Hash[params.map{ |k, v| [k.to_sym, v] }]
+    self.access_token  = params[:access_token]
+    self.refresh_token = params[:refresh_token]
+    self.expires_at    = params[:expires_at] || Time.now.to_i + params[:expires_in].to_i
+    self.expires_in    = params[:expires_in]
+    self.expires       = (params[:expires_at] || params[:expires_in]) ? true : false
+    self.refreshed     = refreshed
+  end
+end

data/lib/vhx/objects/authorization.rb

@@ -0,0 +1,5 @@
+module Vhx
+  class Authorization < VhxObject
+    include Vhx::ApiOperations::Create
+  end
+end

data/lib/vhx/objects/collection.rb

@@ -0,0 +1,8 @@
+module Vhx
+  class Collection < VhxObject
+    include Vhx::ApiOperations::Create
+    include Vhx::ApiOperations::Update
+    include Vhx::ApiOperations::Request
+    include Vhx::ApiOperations::List
+  end
+end

data/lib/vhx/objects/collection_item.rb

@@ -0,0 +1,4 @@
+module Vhx
+  class Collection::Item < VhxObject
+  end
+end

data/lib/vhx/objects/customer.rb

@@ -0,0 +1,8 @@
+module Vhx
+  class Customer < VhxObject
+    include Vhx::ApiOperations::Create
+    include Vhx::ApiOperations::Request
+    include Vhx::ApiOperations::List
+    include Vhx::ApiOperations::Delete
+  end
+end

data/lib/vhx/objects/product.rb

@@ -0,0 +1,6 @@
+module Vhx
+  class Product < VhxObject
+    include Vhx::ApiOperations::Request
+    include Vhx::ApiOperations::List
+  end
+end

data/lib/vhx/objects/site.rb

@@ -0,0 +1,4 @@
+module Vhx
+  class Site < VhxObject
+  end
+end

data/lib/vhx/objects/user.rb

@@ -0,0 +1,10 @@
+module Vhx
+  class User < VhxObject
+    include Vhx::ApiOperations::Request
+
+    def self.me
+      response_json = Vhx.connection.get('/me').body
+      self.new(response_json)
+    end
+  end
+end

data/lib/vhx/objects/video.rb

@@ -0,0 +1,7 @@
+module Vhx
+  class Video < VhxObject
+    include Vhx::ApiOperations::Create
+    include Vhx::ApiOperations::Request
+    include Vhx::ApiOperations::List
+  end
+end

data/lib/vhx/objects/video_file.rb

@@ -0,0 +1,4 @@
+module Vhx
+  class Video::File < VhxObject
+  end
+end

data/lib/vhx/utilities/api_operations/create.rb

@@ -0,0 +1,22 @@
+module Vhx
+  module ApiOperations
+    module Create
+      module ClassMethods
+        def create(payload)
+          klass = get_klass
+          response = Vhx.connection.post do |req|
+            req.url('/' + klass.downcase + 's') #This url is based purely on VHX's API convention.
+            req.body = payload
+          end
+
+          self.new(response.body)
+        end
+      end
+
+      def self.included(klass)
+        klass.extend(Vhx::HelperMethods)
+        klass.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/vhx/utilities/api_operations/delete.rb

@@ -0,0 +1,16 @@
+module Vhx
+  module ApiOperations
+    module Delete
+      module ClassMethods
+        def delete(identifier, payload = {})
+          Vhx.connection.delete(get_hypermedia(identifier), payload)
+        end
+      end
+
+      def self.included(klass)
+        klass.extend(Vhx::HelperMethods)
+        klass.extend(ClassMethods)
+      end
+    end
+  end
+end