vhx-ruby 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 134b9c8e24549b65fe6d38d553c0d786ab86cd55
-  data.tar.gz: 608cef9093c267377aa41769e5fd47233f9530a2
+  metadata.gz: 56058d63c232a5221d030477f8de29ebea8efd62
+  data.tar.gz: 807adb8c7fc959aaa2fe7749a9618aaa07d2d1c1
 SHA512:
-  metadata.gz: f6095076d2b38e520bccc62395f64ca787c3b4c32f8a829fbc9e9bd8b393c7d176bae1d6b948abfcbf42db3630f7c824dc9b156481314c782f2fafe364ab31e7
-  data.tar.gz: f771ba677ea096b041cc86f251d8b4584e61a7487a3de372c86228b96537db1dd7a39b1c45200e618aef620c5ba4a091e531c1fad66abbdc02713120df88b955
+  metadata.gz: 574e551381081eb677a163544611b61d1daec286b5441f3cd60328df803ab80d0356413afe850ac1ec27fe3f151bb35691d505c2e467742a4c6d660408112504
+  data.tar.gz: 9714c5b4e9e6a702afa07db4ca965d187afa1dbbc5efdc3c9287f8d52a422deb1d2da796bdc9402b7162df0ee3d2c6a6e8fe63b1fb0fbf194bd50f4e83c27048

data/README.md

@@ -6,6 +6,29 @@ The VHX API is currently Private Beta. You can request an API key by emailing ap
 
 `gem install vhx-ruby`
 
+#### Building Locally
+
+```shell
+$ gem build vhx.gemspec
+Successfully built RubyGem
+Name: vhx
+Version: 0.0.0
+File: vhx-0.0.0.gem
+
+$ gem install vhx-0.0.0.gem
+Successfully installed vhx-0.0.0
+1 gem installed
+
+$ irb
+irb(main)> require 'vhx'
+```
+
+#### Running Specs
+
+```shell
+rspec .
+```
+
 ### Documentation
 
 Documentation is available at http://dev.vhx.tv/docs/api/ruby.
@@ -16,7 +39,7 @@ Full API reference is available at http://dev.vhx.tv/docs/api?ruby.
 Before requesting your first resource, you must setup an instance of the Vhx Client:
 
 ```ruby
-vhx = Vhx.setup({ api_key: 'your VHX API key'} )
+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.

data/lib/vhx.rb

@@ -36,20 +36,20 @@ module Vhx
 
   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[:auto_refresh]        = @auto_refresh || false 
+      options[:client_id]     ||= @client_id
+      options[:client_secret] ||= @client_secret
+      options[:api_key]       ||= @api_key
+      options[:api_base]      ||= @api_base_url
+      options[:auto_refresh]    = @auto_refresh || false
       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]
-      @auto_refresh       = config[:auto_refresh] || false
-      @api_base_url       = config[:api_base]
+      @client_id     = config[:client_id]
+      @client_secret = config[:client_secret]
+      @api_key       = config[:api_key]
+      @auto_refresh  = config[:auto_refresh] || false
+      @api_base_url  = config[:api_base]
     end
 
     def client

data/lib/vhx/objects/video.rb

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

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

@@ -2,10 +2,17 @@ module Vhx
   module ApiOperations
     module Create
       module ClassMethods
-        def create(payload)
+        def create(payload, headers = {})
           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.url('/' + klass.downcase + 's') # This url is based purely on VHX's API convention.
+
+            if headers.length > 0
+              headers.each do |key, value|
+                req.headers[key] = value
+              end
+            end
+
             req.body = payload
           end
 

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

@@ -2,8 +2,12 @@ module Vhx
   module ApiOperations
     module Delete
       module ClassMethods
-        def delete(identifier, payload = {})
-          Vhx.connection.delete(get_hypermedia(identifier), payload)
+        def delete(identifier, payload = {}, headers = {})
+          Vhx.connection.delete(
+            get_hypermedia(identifier),
+            payload,
+            headers,
+          )
         end
       end
 
@@ -13,4 +17,4 @@ module Vhx
       end
     end
   end
-end
+end

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

@@ -4,13 +4,17 @@ module Vhx
   module ApiOperations
     module List
       module ClassMethods
-        def all(payload = {})
-          response = Vhx.connection.get('/' + get_klass.downcase + 's', payload)
+        def all(payload = {}, headers = {})
+          response = Vhx.connection.get(
+            '/' + get_klass.downcase + 's',
+            payload,
+            headers,
+          )
           VhxListObject.new(response.body, get_klass.downcase + 's')
         end
 
-        def list(payload = {})
-          self.all(payload)
+        def list(payload = {}, headers = {})
+          self.all(payload, headers)
         end
       end
 

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

@@ -2,13 +2,17 @@ module Vhx
   module ApiOperations
     module Request
       module ClassMethods
-        def find(identifier)
-          response = Vhx.connection.get(get_hypermedia(identifier))
+        def find(identifier, payload = {}, headers = {})
+          response = Vhx.connection.get(
+            get_hypermedia(identifier),
+            payload,
+            headers,
+          )
           self.new(response.body)
         end
 
-        def retrieve(identifier)
-          self.find(identifier)
+        def retrieve(identifier, payload = {}, headers = {})
+          self.find(identifier, payload, headers)
         end
       end
 

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

@@ -2,8 +2,8 @@ module Vhx
   module ApiOperations
     module Update
       module InstanceMethods
-        def update(payload)
-          Vhx.connection.put(self.href, payload)
+        def update(payload, headers = {})
+          Vhx.connection.put(self.href, payload, headers)
         end
       end
 
@@ -12,4 +12,4 @@ module Vhx
       end
     end
   end
-end
+end

data/lib/vhx/version.rb

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

data/spec/objects/customer_spec.rb

@@ -12,34 +12,34 @@ describe Vhx::Customer do
   before{
     Vhx.setup({api_key: 'testapikey'})
   }
-  
+
   describe 'api operations' do
 
     describe '::find' do
       it 'does not error' do
         Vhx.connection.stub(:get).and_return(OpenStruct.new(body: customer_response))
-        expect{Vhx::Customer.find(123)}.to_not raise_error 
+        expect{Vhx::Customer.find(123)}.to_not raise_error
       end
-    end 
+    end
 
     describe '::retrieve' do
       it 'does not error' do
         Vhx.connection.stub(:get).and_return(OpenStruct.new(body: customer_response))
-        expect{Vhx::Customer.retrieve(123)}.to_not raise_error 
+        expect{Vhx::Customer.retrieve(123)}.to_not raise_error
       end
     end
 
     describe '::list' do
       it 'does not error' do
         Vhx.connection.stub(:get).and_return(OpenStruct.new(body: customers_response))
-        expect{Vhx::Customer.list()}.to_not raise_error 
+        expect{Vhx::Customer.list()}.to_not raise_error
       end
     end
 
     describe '::all' do
       it 'does not error' do
         Vhx.connection.stub(:get).and_return(OpenStruct.new(body: customers_response))
-        expect{Vhx::Customer.all()}.to_not raise_error 
+        expect{Vhx::Customer.all()}.to_not raise_error
       end
     end
 
@@ -61,13 +61,29 @@ describe Vhx::Customer do
         Vhx.connection.stub(:delete).and_return(OpenStruct.new(body: ""))
         expect{Vhx::Customer.delete(1)}.to_not raise_error
       end
+
+      it "supports headers" do
+        params = [
+          :delete,
+          "https://api.vhx.tv/customers/1",
+          nil,
+          { "VHX-Client-IP" => "1.2.3.4" },
+        ]
+        response = OpenStruct.new(body: "")
+
+        expect_any_instance_of(Faraday::Connection).to receive(:run_request).
+                                                       with(*params).
+                                                       and_return(response)
+
+        Vhx::Customer.delete(1, {}, { 'VHX-Client-IP' => '1.2.3.4' })
+      end
     end
 
     describe '#add_product' do
       it 'returns customer' do
         Vhx.connection.stub(:put).and_return(OpenStruct.new(body: customer_response))
         customer = Vhx::Customer.new(customer_response).add_product(1)
-        expect(customer.class).to eq(Vhx::Customer) 
+        expect(customer.class).to eq(Vhx::Customer)
       end
     end
 
@@ -75,7 +91,7 @@ describe Vhx::Customer do
       it 'returns customer' do
         Vhx.connection.stub(:delete).and_return(OpenStruct.new(body: customer_response))
         customer = Vhx::Customer.new(customer_response).remove_product(1)
-        expect(customer.class).to eq(Vhx::Customer) 
+        expect(customer.class).to eq(Vhx::Customer)
       end
     end
   end

data/spec/objects/video_spec.rb

@@ -13,34 +13,66 @@ describe Vhx::Video do
   before{
     Vhx.setup({api_key: 'testapikey'})
   }
-  
+
   describe 'api operations' do
 
     describe '::find' do
       it 'does not error' do
         Vhx.connection.stub(:get).and_return(OpenStruct.new(body: video_response))
-        expect{Vhx::Video.find(123)}.to_not raise_error 
+        expect{Vhx::Video.find(123)}.to_not raise_error
+      end
+
+      it "supports headers" do
+        params = [
+          :get,
+          "https://api.vhx.tv/videos/123",
+          nil,
+          { "VHX-Client-IP" => "1.2.3.4" },
+        ]
+        response = OpenStruct.new(body: video_response)
+
+        expect_any_instance_of(Faraday::Connection).to receive(:run_request).
+                                                       with(*params).
+                                                       and_return(response)
+
+        Vhx::Video.find(123, {}, { 'VHX-Client-IP' => '1.2.3.4' })
       end
-    end 
+    end
 
     describe '::retrieve' do
       it 'does not error' do
         Vhx.connection.stub(:get).and_return(OpenStruct.new(body: video_response))
-        expect{Vhx::Video.retrieve(123)}.to_not raise_error 
+        expect{Vhx::Video.retrieve(123)}.to_not raise_error
       end
     end
 
     describe '::list' do
       it 'does not error' do
         Vhx.connection.stub(:get).and_return(OpenStruct.new(body: videos_response))
-        expect{Vhx::Video.list()}.to_not raise_error 
+        expect{Vhx::Video.list()}.to_not raise_error
+      end
+
+      it "supports headers" do
+        params = [
+          :get,
+          "/videos",
+          nil,
+          { "VHX-Client-IP" => "1.2.3.4" },
+        ]
+        response = OpenStruct.new(body: videos_response)
+
+        expect_any_instance_of(Faraday::Connection).to receive(:run_request).
+                                                       with(*params).
+                                                       and_return(response)
+
+        Vhx::Video.list({}, { 'VHX-Client-IP' => '1.2.3.4' })
       end
     end
 
     describe '::all' do
       it 'does not error' do
         Vhx.connection.stub(:get).and_return(OpenStruct.new(body: videos_response))
-        expect{Vhx::Video.all()}.to_not raise_error 
+        expect{Vhx::Video.all()}.to_not raise_error
       end
     end
 
@@ -51,9 +83,26 @@ describe Vhx::Video do
       end
     end
 
-    describe '#udpate' do
+    describe '#update' do
       it 'raises error' do
-        expect{Vhx::Video.new({}).update}.to raise_error(NoMethodError)
+        Vhx.connection.stub(:put).and_return(OpenStruct.new(body: video_response))
+        expect{Vhx::Video.new(video_response).update({})}.to_not raise_error(NoMethodError)
+      end
+
+      it "supports headers" do
+        params = [
+          :put,
+          "https://api.vhx.tv/videos/1",
+          { title: "Video" },
+          { "VHX-Client-IP" => "1.2.3.4" },
+        ]
+        response = OpenStruct.new(body: videos_response)
+
+        expect_any_instance_of(Faraday::Connection).to receive(:run_request).
+                                                       with(*params).
+                                                       and_return(response)
+        video = Vhx::Video.new(video_response)
+        video.update({ title: "Video" }, { 'VHX-Client-IP' => '1.2.3.4' })
       end
     end
 
@@ -64,15 +113,14 @@ describe Vhx::Video do
     end
 
     describe '#files' do
-
       def files_response
         JSON.parse(File.read("spec/fixtures/sample_files_response.json"))
       end
-      
+
       it 'fetches linked association' do
         Vhx.connection.stub(:get).and_return(OpenStruct.new(body: files_response))
         files = Vhx::Video.new(video_response).files
-        expect(files.first.class).to eq(Vhx::Video::File) 
+        expect(files.first.class).to eq(Vhx::Video::File)
         expect(Vhx.connection).to have_received(:get)
       end
     end

data/vhx.gemspec

@@ -5,10 +5,10 @@ require 'vhx/version'
 Gem::Specification.new do |spec|
   spec.name           = 'vhx-ruby'
   spec.version        = Vhx::VERSION
-  spec.authors        = ['Sagar Shah']
-  spec.date           = '2017-01-06'
-  spec.description    = 'A Ruby wrapper for the Vhx developer API.'
-  spec.summary        = 'A Ruby wrapper for the Vhx developer API.'
+  spec.authors        = ['Sagar Shah', 'Kevin Sheurs']
+  spec.date           = '2017-02-03'
+  spec.description    = 'A Ruby wrapper for the VHX developer API.'
+  spec.summary        = 'A Ruby wrapper for the VHX developer API.'
   spec.email          = ['sagar@vhx.tv', 'dev@vhx.tv', 'wontae@vhx.tv', 'charlie@vhx.tv', 'kevin@vhx.tv', 'scott@vhx.tv']
   spec.homepage       = 'http://dev.vhx.tv/docs/api/'
   spec.license        = 'MIT'

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: vhx-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Sagar Shah
+- Kevin Sheurs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-06 00:00:00.000000000 Z
+date: 2017-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -66,7 +67,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A Ruby wrapper for the Vhx developer API.
+description: A Ruby wrapper for the VHX developer API.
 email:
 - sagar@vhx.tv
 - dev@vhx.tv
@@ -165,7 +166,7 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: A Ruby wrapper for the Vhx developer API.
+summary: A Ruby wrapper for the VHX developer API.
 test_files:
 - spec/client_spec.rb
 - spec/fixtures/sample_array_list.json