vhx-ruby 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3fc113efc37f664b7f62505bdf410c86ae76cc4
-  data.tar.gz: 1b04aaa9fe91585a6c3be1e6feb3b6340d2a6ca1
+  metadata.gz: 134b9c8e24549b65fe6d38d553c0d786ab86cd55
+  data.tar.gz: 608cef9093c267377aa41769e5fd47233f9530a2
 SHA512:
-  metadata.gz: ae25bb65da0752a96c67c5ad311f49e7caa10c0fec85c0bd36d34699c4ce4ab0c05d55f2d86b2eb32c94986aa653196cedee138b0fbdbc151f53d2d6f3631692
-  data.tar.gz: b1282761cb591341d18d68c6de39d03ac4b4e3c09a80c1c281c4601bd0763ef9e24ab12b5eecc357c9db0cebe43eb2cc8ee857aaf19edbddf1346a0775cf5297
+  metadata.gz: f6095076d2b38e520bccc62395f64ca787c3b4c32f8a829fbc9e9bd8b393c7d176bae1d6b948abfcbf42db3630f7c824dc9b156481314c782f2fafe364ab31e7
+  data.tar.gz: f771ba677ea096b041cc86f251d8b4584e61a7487a3de372c86228b96537db1dd7a39b1c45200e618aef620c5ba4a091e531c1fad66abbdc02713120df88b955

data/README.md

@@ -19,7 +19,7 @@ Before requesting your first resource, you must setup an instance of the Vhx Cli
 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. 
+Here's an example of creating a Vhx resource with payload options. You can handle errors by rescuing Vhx::VhxError.
 
 ```ruby
 begin
@@ -57,3 +57,6 @@ collections
   * [`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)
+
+analytics
+  * [`report`](http://dev.vhx.tv/docs/api/?ruby#analytics)

data/lib/vhx.rb

@@ -29,6 +29,7 @@ require "vhx/objects/video"
 require "vhx/objects/video_file"
 require "vhx/objects/customer"
 require "vhx/objects/authorization"
+require "vhx/objects/analytics"
 
 module Vhx
   API_BASE_URL = 'https://api.vhx.tv'
@@ -39,7 +40,7 @@ module Vhx
       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?
+      options[:auto_refresh]        = @auto_refresh || false 
       Vhx.client = Vhx::Client.new(options)
     end
 
@@ -47,7 +48,7 @@ module Vhx
       @client_id          = config[:client_id]
       @client_secret      = config[:client_secret]
       @api_key            = config[:api_key]
-      @skip_auto_refresh  = config[:skip_auto_refresh] || false
+      @auto_refresh       = config[:auto_refresh] || false
       @api_base_url       = config[:api_base]
     end
 
@@ -63,4 +64,4 @@ module Vhx
       client ? client.connection : nil
     end
   end
-end
+end

data/lib/vhx/client.rb

@@ -7,9 +7,9 @@ module Vhx
       @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)
+      @oauth_token       = options[:api_key] ? nil : OAuthToken.new(options[:oauth_token], refreshed = false)
       @api_key           = options[:api_key]
-      @skip_auto_refresh = options[:skip_auto_refresh]
+      @auto_refresh      = options[:auto_refresh]
       @ssl               = options[:ssl] || {}
       @headers           = {}
 
@@ -21,7 +21,10 @@ module Vhx
         faraday.request  :url_encoded
         faraday.request  :json
         faraday.response :logger
-        faraday.use Vhx::Middleware::OAuth2, :vhx_client => self unless @skip_auto_refresh
+
+        if @auto_refresh
+          faraday.use Vhx::Middleware::OAuth2, :vhx_client => self
+        end
 
         faraday.adapter Faraday.default_adapter
 

data/lib/vhx/objects/analytics.rb

@@ -0,0 +1,9 @@
+module Vhx
+  class Analytics < VhxObject
+    def self.report(query_params = {})
+      response = Vhx.connection.get("/analytics", query_params)
+
+      self.new(response.body)
+    end
+  end
+end

data/lib/vhx/utilities/vhx_object.rb

@@ -75,11 +75,11 @@ module Vhx
       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
+          if payload.empty? && obj_hash['_embedded'] && obj_hash['_embedded'].has_key?(association_method)
             return instance_variable_set("@#{association_method}", fetch_embedded_association(obj_hash, association_method))
           end
 
-          if obj_hash['_links'] && obj_hash['_links'].fetch(association_method, []).length > 0
+          if obj_hash['_links'] && obj_hash['_links'].has_key?(association_method)
             return instance_variable_set("@#{association_method}", fetch_linked_association(obj_hash, association_method, payload))
           end
 

data/lib/vhx/version.rb

@@ -1,3 +1,3 @@
 module Vhx
-  VERSION = "0.0.7"
-end
+  VERSION = "0.0.8"
+end

data/spec/client_spec.rb

@@ -1,20 +1,47 @@
 require 'spec_helper'
 
-describe Vhx::Client, :vcr do
+describe Vhx::Client do
+  def application_only_credentials
+    {api_key: "-12345"}
+  end
+
+  def application_user_credentials
+    {
+      client_id: '12345',
+      client_secret: '12345',
+      oauth_token: {
+        access_token:  "123456",
+        refresh_token: "12345",
+        expires_at: 1430330123,
+        expires_in: 7200
+      }
+    }
+  end
+
   describe 'faraday configuration' do
-    subject(:vhx_client){ Vhx::Client.new(application_only_credentials)}
+    let(: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 'does not utilize oauth2 middleware by default' do
+      expect(vhx_client.connection.builder.handlers).to_not include(Vhx::Middleware::OAuth2)
+    end
+
+    it 'utilizes oauth2 middleware if auto_refresh option passed' do
+      credentials = application_only_credentials.merge(auto_refresh: true)
+      vhx_client = Vhx::Client.new(credentials)
+      expect(vhx_client.connection.builder.handlers).to include(Vhx::Middleware::OAuth2)
+    end
+
     it 'uses api host' do
-      expect(vhx_client.connection.url_prefix.host).to eq 'api.crystal.dev'
+      expect(vhx_client.connection.url_prefix.host).to eq 'api.vhx.tv'
     end
   end
 
   context 'application_only' do
-    subject(:vhx_client){ Vhx::Client.new(application_only_credentials)}
+    let(:vhx_client){ Vhx::Client.new(application_only_credentials)}
 
     describe 'connection' do
       it 'initializes faraday connection' do
@@ -32,7 +59,7 @@ describe Vhx::Client, :vcr do
   end
 
   context 'application_user' do
-    subject(:vhx_client){ Vhx::Client.new(application_user_credentials)}
+    let!(:vhx_client){ Vhx::Client.new(application_user_credentials)}
 
     it 'oauth_token presence' do
       expect(vhx_client.oauth_token).to be_an_instance_of(OAuthToken)
@@ -53,17 +80,25 @@ describe Vhx::Client, :vcr do
     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! }
+      let(:oauth_token){ vhx_client.oauth_token }
 
       it 'oauth_token refreshed' do
+        new_token_hash = {access_token: '123', refresh_token: '456', expires_in: '3600'}
+        new_token_response = OpenStruct.new(body: new_token_hash)
+        Faraday::Connection.any_instance.stub(:post).and_return(new_token_response)
+        original_access_token = oauth_token.access_token 
+        vhx_client.refresh_access_token! 
         expect(vhx_client.oauth_token.refreshed).to eq(true)
       end
 
       it 'access_token changed' do
+        new_token_hash = {access_token: '123', refresh_token: '456', expires_in: '3600'}
+        new_token_response = OpenStruct.new(body: new_token_hash)
+        Faraday::Connection.any_instance.stub(:post).and_return(new_token_response)
+        original_access_token = oauth_token.access_token 
+        vhx_client.refresh_access_token! 
         expect(vhx_client.oauth_token.access_token).to_not eq(original_access_token)
       end
     end
   end
-end
+end

data/spec/fixtures/sample_authorization_response.json

@@ -0,0 +1,19 @@
+{
+  "_links": {
+    "customer": {
+      "href": "https://api.vhx.tv/customers/1"
+    },
+    "video": {
+      "href": "https://api.vhx.tv/videos/1"
+    }
+  },
+  "token": "QVJ-cavyvwSX6JpafMCX7zsd1wKg2XfDuZnN",
+  "expires_at": "2015-11-10T23:46:46Z",
+  "player": {
+    "host": "https://embed.vhx.tv",
+    "path": "/videos/1",
+    "html": "<iframe src=\"https://embed.vhx.tv/videos/1?authorization=QVJ-cavyvwSX6JpafMCX7zsd1wKg2XfDuZnN\" width=\"640\" height=\"360\" frameborder=\"0\" webkitAllowFullScreen mozallowfullscreen allowFullScreen></iframe>"
+  },
+  "created_at": "2015-11-10T22:46:46Z",
+  "updated_at": "2015-11-10T22:46:46Z"
+}

data/spec/fixtures/sample_collection_response.json

@@ -0,0 +1,20 @@
+{
+  "_links": {
+    "self":  { "href": "https://api.vhx.tv/collections/1" },
+    "items": { "href": "https://api.vhx.tv/collections/1/items" }
+  },
+  "id": 1,
+  "name": "Comedy",
+  "description": "Comedy series and movies.",
+  "slug": "comedy",
+  "thumbnail": {
+    "small": "https://cdn.vhx.tv/assets/thumbnails/default-small.png",
+    "medium": "https://cdn.vhx.tv/assets/thumbnails/default-medium.png",
+    "large": "https://cdn.vhx.tv/assets/thumbnails/default-large.png",
+    "source": "https://cdn.vhx.tv/assets/thumbnails/original.jpg"
+  },
+  "type": "category",
+  "items_count": 10,
+  "created_at": "2014-02-25T20:19:30Z",
+  "updated_at": "2014-02-25T20:19:30Z"
+}

data/spec/fixtures/sample_collections_response.json

@@ -0,0 +1,14 @@
+{
+  "_links": {
+    "self":  { "href": "https://api.vhx.tv/collections?page=1&product=:href" },
+    "first": { "href": "https://api.vhx.tv/collections?product=:href" },
+    "prev":  { "href": null },
+    "next":  { "href": "https://api.vhx.tv/collections?page=2&product=:href" },
+    "last":  { "href": "https://api.vhx.tv/collections?page=5&product=:href" }
+  },
+  "count": 100,
+  "total": 500,
+  "_embedded": {
+    "collections": []
+  }
+}

data/spec/fixtures/sample_create_video_response.json

@@ -0,0 +1,33 @@
+{
+  "_links": {
+    "self":  { "href": "https://api.vhx.tv/videos/1" },
+    "files": { "href": "https://api.vhx.tv/videos/1/files" }
+  },
+  "_embedded": {
+    "files": []
+  },
+  "id": 1,
+  "title": "My Video",
+  "description": "My video description.",
+  "status": "processing",
+  "duration": {
+    "seconds": 7200,
+    "formatted": "02:00:00"
+  },
+  "thumbnail": {
+    "small": "https://cdn.vhx.tv/assets/thumbnails/default-small.png",
+    "medium": "https://cdn.vhx.tv/assets/thumbnails/default-medium.png",
+    "large": "https://cdn.vhx.tv/assets/thumbnails/default-large.png",
+    "source": "https://cdn.vhx.tv/assets/thumbnails/original.jpg"
+  },
+  "tracks": {
+    "subtitles": []
+  },
+  "advertising": {},
+  "metadata": {
+    "advertising_keywords": []
+  },
+  "files_count": 0,
+  "created_at": "2014-02-25T20:19:30Z",
+  "updated_at": "2014-02-25T20:19:30Z"
+}

data/spec/fixtures/sample_customer_response.json

@@ -0,0 +1,16 @@
+{
+  "_links": {
+    "self":  { "href": "https://api.vhx.tv/customers/1" },
+    "watchlist": { "href": "https://api.vhx.tv/customers/1/watchlist" },
+    "watching": { "href": "https://api.vhx.tv/customers/1/watching" },
+    "products": { "href": "https://api.vhx.tv/products/1" }
+  },
+  "_embedded": {
+    "products": []
+  },
+  "id": 1,
+  "name": "First Last",
+  "email": "customer@email.com",
+  "created_at": "2014-02-25T20:19:30Z",
+  "updated_at": "2014-02-25T20:19:30Z"
+}

data/spec/fixtures/sample_customers_response.json

@@ -0,0 +1,28 @@
+{
+  "_links": {
+    "self":  { "href": "https://api.vhx.tv/customers?page=1&query=term" },
+    "first": { "href": "https://api.vhx.tv/customers?query=term" },
+    "prev":  { "href": null },
+    "next":  { "href": "https://api.vhx.tv/customers?page=2&query=term" },
+    "last":  { "href": "https://api.vhx.tv/customers?page=5&query=term" }
+  },
+  "count": 100,
+  "total": 500,
+  "_embedded": {
+    "customers": [
+      {
+        "_links": {
+          "self":  { "href": "https://api.vhx.tv/customers/1" },
+          "watchlist": { "href": "https://api.vhx.tv/customers/1/watchlist" },
+          "watching": { "href": "https://api.vhx.tv/customers/1/watching" }
+        },
+        "_embedded": {},
+        "id": 1,
+        "name": "First Last",
+        "email": "customer@email.com",
+        "created_at": "2014-02-25T20:19:30Z",
+        "updated_at": "2014-02-25T20:19:30Z"
+      }
+    ]
+  }
+}

data/spec/fixtures/sample_files_response.json

@@ -0,0 +1,16 @@
+[{
+  "_links": {
+    "self":   { "href": "https://api.vhx.tv/videos/1/files?quality=adaptive&format=m3u8" },
+    "source": { "href": "https://video.vhx.tv/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_product_response.json

@@ -0,0 +1,30 @@
+{
+  "_links": {
+    "self":        { "href": "https://api.vhx.tv/products/1" },
+    "collections": { "href": "https://api.vhx.tv/collections?product=:href" },
+    "customers":   { "href": "https://api.vhx.tv/customers?product=:href" }
+  },
+  "_embedded": {},
+  "id": 1,
+  "name": "Subscription NOW",
+  "description": "Subscribe to Subscription NOW today!",
+  "thumbnail": {},
+  "price": {
+    "monthly": {
+      "cents": 800,
+      "currency": "USD",
+      "formatted": "$8"
+    },
+    "yearly": {
+      "cents": 6500,
+      "currency": "USD",
+      "formatted": "$65"
+    }
+  },
+  "is_active": true,
+  "series_count": 100,
+  "movies_count": 100,
+  "playlists_count": 100,
+  "created_at": "2014-02-25T20:19:30Z",
+  "updated_at": "2014-02-25T20:19:30Z"
+}

data/spec/fixtures/sample_products_response.json

@@ -0,0 +1,14 @@
+{
+  "_links": {
+    "self":  { "href": "https://api.vhx.tv/products?page=1&query=term" },
+    "first": { "href": "https://api.vhx.tv/products?query=term" },
+    "prev":  { "href": null },
+    "next":  { "href": "https://api.vhx.tv/products?page=2&query=term" },
+    "last":  { "href": "https://api.vhx.tv/products?page=5&query=term" }
+  },
+  "count": 100,
+  "total": 500,
+  "_embedded": {
+    "products": []
+  }
+}

data/spec/fixtures/sample_video_response.json

@@ -1,35 +1,24 @@
 {
   "_links": {
-    "self":  { "href": "http://api.crystal.dev/videos/1" },
-    "site":  { "href": "http://api.crystal.dev/sites/1" },
-    "files": { "href": "http://api.crystal.dev/videos/1/files" }
+    "self":  { "href": "https://api.vhx.tv/videos/1" },
+    "files": { "href": "https://api.vhx.tv/videos/1/files" }
   },
   "_embedded": {
-    "site": {},
-    "subtitles": [{
-      "_links": {
-        "self":  { "href": "http://cdn.crystal.dev/assets/spanish.srt" },
-        "video": { "href": "http://api.crystal.dev/videos/1" },
-        "site":  { "href": "http://api.crystal.dev/sites/1" }
-      },
-      "language": "Spanish",
-      "type": "srt"
-    }],
-    "files": [{
-      "_links": {
-        "self":  { "href": "http://api.crystal.dev/videos/1/files?quality=adaptive&format=m3u8" },
-        "video": { "href": "http://api.crystal.dev/videos/1" },
-        "site":  { "href": "http://api.crystal.dev/sites/1" }
-      },
-      "quality": "adaptive",
-      "format": "m3u8",
-      "method": "hls",
-      "size": {
-        "bytes": 1073741824,
-        "formatted": "1 GB"
-      },
-      "mime_type": "application/x-mpegURL"
-    }]
+    "files": [
+      {
+        "_links": {
+          "self":  { "href": "https://api.vhx.tv/videos/1/files?quality=adaptive&format=m3u8" }
+        },
+        "quality": "adaptive",
+        "format": "m3u8",
+        "method": "hls",
+        "size": {
+          "bytes": 1073741824,
+          "formatted": "1 GB"
+        },
+        "mime_type": "application/x-mpegURL"
+      }
+    ]
   },
   "id": 1,
   "title": "My Video",
@@ -42,10 +31,37 @@
   "thumbnail": {
     "small": "https://cdn.vhx.tv/assets/thumbnails/default-small.png",
     "medium": "https://cdn.vhx.tv/assets/thumbnails/default-medium.png",
-    "large": "https://cdn.vhx.tv/assets/thumbnails/default-large.png"
+    "large": "https://cdn.vhx.tv/assets/thumbnails/default-large.png",
+    "source": "https://cdn.vhx.tv/assets/thumbnails/original.jpg"
+  },
+  "tracks": {
+    "subtitles": [
+      {
+        "_links": {
+            "srt": { "href": "https://cdn.vhx.tv/file.srt" },
+            "vtt": { "href": "https://cdn.vhx.tv/file.vtt" }
+        },
+        "label": "English",
+        "srclang": "en",
+        "kind": "subtitles"
+      }
+    ]
+  },
+  "advertising": {
+    "_links": {
+      "tag": { "href": "https://static.vhx.tv/vmap.xml" }
+    },
+    "client": "vmap",
+    "provider": "dfp"
+  },
+  "metadata": {
+    "series_name": "Series Name",
+    "season_name": "Season 1",
+    "season_number": 1,
+    "episode_number": 5,
+    "advertising_keywords": []
   },
-  "subtitles_count": 3,
   "files_count": 5,
   "created_at": "2014-02-25T20:19:30Z",
   "updated_at": "2014-02-25T20:19:30Z"
-}
+}