vhx-ruby 0.0.2

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

@@ -0,0 +1,21 @@
+require_relative '../vhx_list_object'
+
+module Vhx
+  module ApiOperations
+    module List
+      module ClassMethods
+        def all(payload = {})
+          response = Vhx.connection.get do |req|
+            req.url '/' + get_klass.downcase + 's'
+            req.body = payload
+          end
+          VhxListObject.new(response.body, get_klass.downcase + 's')
+        end
+      end
+
+      def self.included(klass)
+        klass.extend(ClassMethods)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Vhx
+  module ApiOperations
+    module Request
+      module ClassMethods
+        def find(identifier)
+          response = Vhx.connection.get(get_hypermedia(identifier))
+          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/update.rb

@@ -0,0 +1,15 @@
+module Vhx
+  module ApiOperations
+    module Update
+      module InstanceMethods
+        def update(payload)
+          Vhx.connection.put(self.href, payload)
+        end
+      end
+
+      def self.included(klass)
+        klass.include(InstanceMethods)
+      end
+    end
+  end
+end

data/lib/vhx/utilities/vhx_helper.rb

@@ -0,0 +1,20 @@
+module Vhx
+  module HelperMethods
+    def get_klass
+      if self.is_a?(Class)
+        self.to_s.split("::").last
+      else
+        self.class.to_s.split("::").last
+      end
+    end
+
+    def get_hypermedia(identifier, klass = nil)
+      if identifier.class.to_s.match(/Integer|Fixnum/)
+        klass ||= get_klass
+        return Vhx.client.api_base_url + '/' + klass.downcase + 's' + '/' + identifier.to_s #This url is based purely on VHX's API convention (not nested).
+      end
+
+      identifier
+    end
+  end
+end

data/lib/vhx/utilities/vhx_list_object.rb

@@ -0,0 +1,44 @@
+module Vhx
+  class VhxListObject < Array
+
+    def initialize(obj, list_type)
+      @obj = obj
+
+      if @obj.is_a?(Array)
+        ar = @obj.map{|association_hash| Object.const_get("Vhx::#{vhx_object_type(list_type)}").new(association_hash)}
+      elsif @obj.is_a?(Hash)
+        @previous, @next = @obj['_links']['prev']['href'], @obj['_links']['next']['href']
+        @total   = @obj['total']
+        ar = @obj['_embedded'][list_type].map{|association_hash| Object.const_get("Vhx::#{vhx_object_type(list_type)}").new(association_hash)}
+      end
+
+      super(ar)
+    end
+
+    def previous
+      @previous # TODO
+    end
+
+    def next
+      @next # TODO
+    end
+
+    def total
+      @total
+    end
+
+  protected
+
+    def vhx_object_type(list_type)
+      case list_type
+      when 'items'
+        'Collection::Item'
+      when 'files'
+        'Video::File'
+      else
+        list_type.gsub(/s\z/, '').capitalize
+      end
+    end
+
+  end
+end

data/lib/vhx/utilities/vhx_object.rb

@@ -0,0 +1,106 @@
+module Vhx
+  class VhxObject
+    include HelperMethods
+    ASSOCIATION_WHITELIST = ['products', 'sites', 'site', 'videos', 'video', 'subscription', 'files', 'items', 'customer']
+
+    def initialize(obj_hash)
+      @obj_hash = obj_hash
+
+      validate_class(obj_hash)
+      create_readers(obj_hash)
+      create_associations(obj_hash)
+    end
+
+    def to_json
+      @obj_hash.to_json
+    end
+
+    def to_hash
+      @obj_hash
+    end
+
+    def href
+      @obj_hash['_links']['self']['href']
+    end
+
+    def links
+      data = {}
+      @obj_hash['_links'].each do |k, v|
+        data[k] = v['href']
+      end
+      return OpenStruct.new(data)
+    end
+
+  protected
+    def validate_class(obj_hash)
+      return nil unless obj_hash['_links'].fetch('self', nil)
+
+      href  = obj_hash['_links']['self']['href']
+      klass = self.class.to_s.split("::")
+      klass.shift #strip out Vhx
+      klass = klass.join("_").downcase
+
+      is_valid_match = case klass
+      when 'collection_item'
+        href.match('video|file|collection')
+      when 'video_file'
+        href.match('file')
+      else
+        href.match(klass)
+      end
+
+      unless is_valid_match
+        raise InvalidResourceError.new 'The resource returned from the API does not match the resource requested'
+      end
+    end
+
+    def create_readers(obj_hash)
+      obj_hash.keys.each do |key|
+        next if key.match(/embedded|links/)
+        self.class.send(:define_method, key) do
+          return obj_hash[key]
+        end
+      end
+    end
+
+    def create_associations(obj_hash)
+      associations = (obj_hash.fetch('_links', {}).keys | obj_hash.fetch('_embedded', {}).keys).select{|k| ASSOCIATION_WHITELIST.include?(k)}
+      associations.each do |association_method|
+        self.class.send(:define_method, association_method) do |payload = {}|
+          if payload.empty? && obj_hash['_embedded'] && obj_hash['_embedded'].fetch(association_method, []).length > 0
+            return fetch_embedded_association(obj_hash, association_method)
+          end
+
+          if obj_hash['_links'] && obj_hash['_links'].fetch(association_method, []).length > 0
+            return fetch_linked_association(obj_hash, association_method, payload)
+          end
+
+          raise InvalidResourceError.new 'Association does not exist'
+        end
+      end
+    end
+
+    def fetch_embedded_association(obj_hash, association_method)
+      association_obj = obj_hash['_embedded'][association_method]
+      build_association(association_obj, association_method)
+    end
+
+    def fetch_linked_association(obj_hash, association_method, payload = {})
+      response = Vhx.connection.get do |req|
+        req.url(obj_hash['_links'][association_method]['href'].gsub(Vhx.client.api_base_url, ""))
+        req.body = payload
+      end
+
+      build_association(response.body, association_method)
+    end
+
+    def build_association(association_obj, association_method)
+      # Support for legacy arrays, and new list objects starting with Video resource
+      if association_obj.is_a?(Array) || association_obj.has_key?('total')
+        return VhxListObject.new(association_obj, association_method)
+      end
+
+      Object.const_get("Vhx::#{association_method.gsub(/s\z/, '').capitalize}").new(association_obj)
+    end
+  end
+end

data/lib/vhx/version.rb

@@ -0,0 +1,3 @@
+module Vhx
+  VERSION = "0.0.2"
+end

data/spec/client_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Vhx::Client, :vcr do
+  describe 'faraday configuration' do
+    subject(:vhx_client){ Vhx::Client.new(application_only_credentials)}
+
+    it 'uses custom error response middleware' do
+      expect(vhx_client.connection.builder.handlers).to include(Vhx::Middleware::ErrorResponse)
+    end
+
+    it 'uses api host' do
+      expect(vhx_client.connection.url_prefix.host).to eq 'api.crystal.dev'
+    end
+  end
+
+  context 'application_only' do
+    subject(:vhx_client){ Vhx::Client.new(application_only_credentials)}
+
+    describe 'connection' do
+      it 'initializes faraday connection' do
+        expect(vhx_client.connection).to be_an_instance_of(Faraday::Connection)
+      end
+
+      it 'authorization header presence' do
+        expect(vhx_client.connection.headers['Authorization']).to_not be_nil
+      end
+
+      it 'basic auth presence' do
+        expect(vhx_client.connection.headers['Authorization']).to match /Basic/
+      end
+    end
+  end
+
+  context 'application_user' do
+    subject(:vhx_client){ Vhx::Client.new(application_user_credentials)}
+
+    it 'oauth_token presence' do
+      expect(vhx_client.oauth_token).to be_an_instance_of(OAuthToken)
+    end
+
+    describe 'connection' do
+      it 'initializes faraday connection' do
+        expect(vhx_client.connection).to be_an_instance_of(Faraday::Connection)
+      end
+
+      it 'authorization header presence' do
+        expect(vhx_client.connection.headers['Authorization']).to_not be_nil
+      end
+
+      it 'Bearer auth presence' do
+        expect(vhx_client.connection.headers['Authorization']).to match /Bearer/
+      end
+    end
+
+    describe '#refresh_access_token!' do
+      subject(:oauth_token){ vhx_client.oauth_token }
+      let!(:original_access_token){ oauth_token.access_token }
+      before { vhx_client.refresh_access_token! }
+
+      it 'oauth_token refreshed' do
+        expect(vhx_client.oauth_token.refreshed).to eq(true)
+      end
+
+      it 'access_token changed' do
+        expect(vhx_client.oauth_token.access_token).to_not eq(original_access_token)
+      end
+    end
+  end
+end

data/spec/fixtures/sample_array_list.json

@@ -0,0 +1,15 @@
+[{
+  "_links": {
+    "self":  { "href": "https://api.vhx.tv/videos/1/files?quality=adaptive&format=m3u8" },
+    "video": { "href": "https://api.vhx.tv/videos/1" },
+    "site":  { "href": "https://api.vhx.tv/sites/1" }
+  },
+  "quality": "adaptive",
+  "format": "m3u8",
+  "method": "hls",
+  "size": {
+    "bytes": 1073741824,
+    "formatted": "1 GB"
+  },
+  "mime_type": "application/x-mpegURL"
+}]

data/spec/fixtures/sample_file_response.json

@@ -0,0 +1,18 @@
+{
+  "_links": {
+    "self":   { "href": "http://api.crystal.dev/videos/3008/files?quality=adaptive&format=m3u8" },
+    "video":  { "href": "http://api.crystal.dev/videos/3008" },
+    "site":   { "href": "http://api.crystal.dev/sites/1900" },
+    "source": { "href": "http://video.crystal.dev/mymovie/adaptive.m3u8?token=f4v3v3i4c2o209_3" }
+  },
+  "quality": "adaptive",
+  "format": "m3u8",
+  "method": "hls",
+  "size": {
+    "bytes": 1073741824,
+    "formatted": "1 GB"
+  },
+  "mime_type": "application/x-mpegURL",
+  "created_at": "2014-02-25T20:19:30Z",
+  "updated_at": "2014-02-25T20:19:30Z"
+}

data/spec/fixtures/sample_hash_list.json

@@ -0,0 +1,23 @@
+{
+  "_links": {
+    "prev": {"href": "pending"},
+    "next": {"href": "pending"}
+  },
+  "_embedded": {
+    "files": [{
+      "_links": {
+        "self":  { "href": "https://api.vhx.tv/videos/1/files?quality=adaptive&format=m3u8" },
+        "video": { "href": "https://api.vhx.tv/videos/1" },
+        "site":  { "href": "https://api.vhx.tv/sites/1" }
+      },
+      "quality": "adaptive",
+      "format": "m3u8",
+      "method": "hls",
+      "size": {
+        "bytes": 1073741824,
+        "formatted": "1 GB"
+      },
+      "mime_type": "application/x-mpegURL"
+    }]
+  }
+}

data/spec/fixtures/sample_package_response.json

@@ -0,0 +1,185 @@
+{
+  "_links": {
+    "self": {
+      "href": "http://api.crystal.dev/packages/1025"
+    },
+    "site": {
+      "href": "http://api.crystal.dev/sites/1900"
+    },
+    "videos": {
+      "href": "http://api.crystal.dev/packages/1025/videos"
+    },
+    "buy_page": {
+      "href": "http://sagartestmovie.crystal.dev/buy/testing123"
+    },
+    "home_page": {
+      "href": "http://sagartestmovie.crystal.dev/packages/testing123"
+    }
+  },
+  "_embedded": {
+    "site": {
+      "_links": {
+        "self": {
+          "href": "http://api.crystal.dev/sites/1900"
+        },
+        "home_page": {
+          "href": "http://sagartestmovie.crystal.dev"
+        },
+        "followers": {
+          "href": "http://api.crystal.dev/sites/1900/followers"
+        }
+      },
+      "id": 1900,
+      "title": "SagarTestMovie",
+      "description": "This is my test movie. ",
+      "domain": "sagartestmovie.crystal.dev",
+      "subdomain": "sagartestmovie",
+      "key": "sagartestmovie",
+      "color": "#28DBF7",
+      "facebook_url": null,
+      "twitter_name": null,
+      "google_analytics_id": "",
+      "packages_count": 2,
+      "videos_count": 4,
+      "followers_count": 31,
+      "created_at": "2013-12-27T00:20:28Z",
+      "updated_at": "2015-05-04T20:46:01Z"
+    },
+    "videos": [
+      {
+        "_links": {
+          "self": {
+            "href": "http://api.crystal.dev/videos/3008"
+          },
+          "site": {
+            "href": "http://api.crystal.dev/sites/1900"
+          },
+          "files": {
+            "href": "http://api.crystal.dev/videos/3008/files"
+          }
+        },
+        "_embedded": {
+          "subtitles": [
+            {
+              "_links": {
+                "self": {
+                  "href": "http://api.crystal.dev/videos/7726"
+                },
+                "video": {
+                  "href": "http://api.crystal.dev/videos/3008"
+                },
+                "site": {
+                  "href": "http://api.crystal.dev/sites/1900"
+                }
+              },
+              "language": "Bengali",
+              "type": "video"
+            },
+            {
+              "_links": {
+                "self": {
+                  "href": "http://api.crystal.dev/videos/5558"
+                },
+                "video": {
+                  "href": "http://api.crystal.dev/videos/3008"
+                },
+                "site": {
+                  "href": "http://api.crystal.dev/sites/1900"
+                }
+              },
+              "language": "English",
+              "type": "video"
+            }
+          ]
+        },
+        "id": 3008,
+        "title": "Test Movie",
+        "description": "Testing",
+        "status": "uploaded",
+        "duration": {
+          "seconds": 19,
+          "formatted": "00:00:19"
+        },
+        "thumbnail": {
+          "small": "https://dv6n47kh00ig2.cloudfront.net/sagartestmovie/assets/images/video-3008-1403716255-240x135.jpg",
+          "medium": "https://dv6n47kh00ig2.cloudfront.net/sagartestmovie/assets/images/video-3008-1403716255-640x360.jpg",
+          "large": "https://dv6n47kh00ig2.cloudfront.net/sagartestmovie/assets/images/video-3008-1403716255-1280x720.jpg"
+        },
+        "is_drm_enabled": false,
+        "subtitles_count": 2,
+        "files_count": 5,
+        "created_at": "2014-02-06T05:30:18Z",
+        "updated_at": "2015-02-18T16:21:24Z",
+        "position": 0
+      },
+      {
+        "_links": {
+          "self": {
+            "href": "http://api.crystal.dev/videos/7830"
+          },
+          "site": {
+            "href": "http://api.crystal.dev/sites/1900"
+          },
+          "files": {
+            "href": "http://api.crystal.dev/videos/7830/files"
+          }
+        },
+        "_embedded": {
+          "subtitles": [
+
+          ]
+        },
+        "id": 7830,
+        "title": "test movie",
+        "description": null,
+        "status": null,
+        "duration": {
+          "seconds": 0,
+          "formatted": "00:00:00"
+        },
+        "thumbnail": {
+          "small": "http://cdn.crystal.dev/assets/thumbnails/default-small.png",
+          "medium": "http://cdn.crystal.dev/assets/thumbnails/default-medium.png",
+          "large": "http://cdn.crystal.dev/assets/thumbnails/default-large.png"
+        },
+        "is_drm_enabled": false,
+        "subtitles_count": 0,
+        "files_count": 0,
+        "created_at": "2014-07-14T15:19:03Z",
+        "updated_at": "2015-05-04T19:36:50Z",
+        "position": 1
+      }
+    ],
+    "trailer": null
+  },
+  "id": 1025,
+  "title": "testing123",
+  "description": "test",
+  "sku": "testing123",
+  "price": {
+    "cents": 200,
+    "currency": "USD",
+    "formatted": "$2",
+    "US": {
+      "cents": 200,
+      "currency": "USD",
+      "formatted": "$2"
+    }
+  },
+  "rental": null,
+  "trailer_url": null,
+  "trailer_embed_code": "<iframe src=\"http://embed.crystal.dev/packages/1025\" width=\"640\" height=\"360\" frameborder=\"0\" webkitAllowFullScreen mozallowfullscreen allowFullScreen></iframe>",
+  "thumbnail": {
+    "small": "http://cdn.crystal.dev/assets/thumbnails/default-small.png",
+    "medium": "http://cdn.crystal.dev/assets/thumbnails/default-medium.png",
+    "large": "http://cdn.crystal.dev/assets/thumbnails/default-large.png",
+    "blurred": null
+  },
+  "is_active": false,
+  "is_preorder": false,
+  "release_date": null,
+  "videos_count": 2,
+  "extras_count": 0,
+  "created_at": "2014-02-06T18:00:39Z",
+  "updated_at": "2015-02-18T16:21:15Z"
+}