vzaar_api 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a66c41aa22b7ac34c00d55f887bd51e67f477326
+  data.tar.gz: aabba334cffe595e17690a893a0eabc8a5a0dc3f
+SHA512:
+  metadata.gz: 8d39461adbe0756c34809fb76ca493fb1686d74ab3f4910c2cbfdb1340fc38255b5647f4d91c1cb10cdcd956e82146003f307659ec59ca7c4df97b1ad5d09c15
+  data.tar.gz: 4159a4a63fa90ef7f28306bd045fe6dda90828ee137bc2eaa7265cb158dc0e33870d5dc3b5245d273f2378dc39076a148f1732b28966945be56ec8fb37e4af71

data/.gitignore

@@ -0,0 +1,13 @@
+.DS_Store
+*.gem
+.bundle
+.gemtags
+.tags
+api_envs.yml
+Gemfile.lock
+pkg/*
+tmp
+test*.rb
+.ruby-gemset
+.ruby-version
+tags

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format Fuubar
+--require vzaar_api_helper
+--require spec_helper

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.3.0

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 2.2.5
+  - 2.3.1

data/Changelog

@@ -0,0 +1,50 @@
+[2.0.0] 2017-07-13 Alan Oliver <alan@vzaar.com>
+
+  * Version 2.0.0 of the gem released, this gem version contains BREAKING
+  CHANGES.
+  * This gem uses version 2 of the vzaar API, providing a simpler, cleaner way
+  to interact with vzaar.
+  * The Gem has been fully rewritten to conform to the new API.
+  * You can see documentation of the new API at our new developer hub at
+  https://developer.vzaar.com/docs
+
+[1.6.2] 2016-05-19 EJ <ed@vzaar.com>
+
+  * add metadata to signature API call and S3 uploads
+
+[1.6.1] 2016-04-21 EJ <ed@vzaar.com>
+
+  * escape ampersands in filename when sending signature request
+
+[1.6.0] 2016-03-03 EJ <ed@vzaar.com>
+
+  * support for chunked uploads
+
+[1.5.3] 2015-07-07 Raz Itzhakian <raz.itzhakian@fiverr.com>
+
+  * timeout option added for API calls
+
+[1.5.2] 2015-03-30 JC <jozef@vzaar.com>
+
+  * call CGI.escape against link_upload/url and video/seo_url params
+
+[1.5.1] 2015-03-27 JC <jozef@vzaar.com>
+
+  * escaping special chars from xml added
+
+2015-02-19 JC <jozef@vzaar.com>
+
+  * renditions added to Vzaar::Resource::Video
+
+2015-02-16 JC <jozef@vzaar.com>
+
+  * private and seo_url params added to api#edit_video
+  * API specs improved for edit_video/json
+
+2015-01-21 JC <jozef@vzaar.com>
+
+  * API specs added for edit/delete http verbs
+
+2015-01-14 JC <jozef@vzaar.com>
+
+	* changelog added

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Guardfile

@@ -0,0 +1,25 @@
+guard :rspec, cmd: "bundle exec rspec", all_on_start: true do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+  clearing :on
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/vzaar_api.rb$})       { "spec" }
+  watch(%r{^lib/vzaar_api/(.+)\.rb$}) { "spec" }
+  watch(%r{^spec/support/(.+)\.rb$})  { 'spec' }
+
+  watch('spec/vzaar_api_helper.rb')   { "spec" }
+  watch('spec/spec_helper.rb')        { "spec" }
+end

data/README.md

@@ -0,0 +1,55 @@
+# vzaar API
+
+![vzaar Logo](https://raw.github.com/vzaar/vzaar-api-ruby/master/vzaar.png)
+
+By [vzaar](http://vzaar.com)
+
+[![Build Status](https://secure.travis-ci.org/vzaar/vzaar-api-ruby.png)](http://travis-ci.org/vzaar/vzaar-api-ruby) [![Code Climate](https://codeclimate.com/github/vzaar/vzaar-api-ruby.png)](https://codeclimate.com/github/vzaar/vzaar-api-ruby)
+
+vzaar's Ruby client for interacting with version 2 of the [vzaar API](https://vzaar.readme.io/docs).
+
+## Requirements
+
+Ruby 2.2+
+
+## Installation
+
+```
+gem install vzaar --version
+```
+
+
+## Backwards compatability
+
+Versions 1 and 2 of the vzaar API are incompatable with each other. The same applies to the API SDKs. Some functionality available in the version 1 SDK has been deprecated in version 2 and will not be implemented. The version 2 API also has a different authentication mechanism so your existing API key will not work with version 2 SDKs.
+
+To ease migration to the version 2 SDK, it is possible to use both versions without any conflicts.
+
+```
+Vzaar       # <= this is version 1
+VzaarApi    # <= this is version 2
+```
+
+## Usage
+
+Configure your API credentials:
+
+```
+VzaarApi.auth_token = '<your-auth-token>'
+VzaarApi.client_id  = '<your-client-id>'
+```
+
+Usage instructions and examples are available on [vzaar's documentation site](https://vzaar.readme.io).
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,26 @@
+# uncomment these lines when this library is gemified
+# require 'bundler/gem_tasks'
+# Bundler::GemHelper.install_tasks
+
+desc "Run all specs"
+task :default do
+  exec 'rspec spec'
+end
+
+namespace :spec do
+  namespace :api do
+
+    task :dev do
+      exec 'API_ENV=development bundle exec rspec examples'
+    end
+
+    task :qa do
+      exec 'API_ENV=qa bundle exec rspec examples'
+    end
+
+    task :prod do
+      exec 'API_ENV=production bundle exec rspec examples'
+    end
+
+  end
+end

data/examples/README.md

@@ -0,0 +1,33 @@
+# Integration specs
+
+## Setup
+
+Copy the `api_envs.yml.example` file into the root of this repository.
+
+```
+cp examples/api_envs.yml.example api_envs.yml
+```
+
+Then edit your new file with the relevant information for the envionment you wish to target.
+You will need the following to be setup in the relevant account:
+
+1. Your category should have at least 3 sub-categories.
+2. Ensure your account has access to the following encoding presets: `2, 3, 4, 5, 6`
+3. You need at least 2 ingest recipes.
+
+## Running the examples
+
+From the root of this repository:
+
+```
+# development
+rake spec:api:dev
+
+# prodcution
+rake spec:api:prod
+```
+
+## Verifying the results
+
+The `Video` examples will upload and process multiple videos. You should always check
+that these videos actually encode as expected.

data/examples/api_envs.yml.example

@@ -0,0 +1,31 @@
+development:
+  hostname: app.vzaar.localhost
+  vd_hostname: view.vzaar.localhost
+  category_id:
+  encoding_preset_id:
+  ingest_recipe:
+    default:
+    other:
+
+  account_owner:
+    auth_token:
+    client_id:
+
+  intruder:
+    auth_token: some-secret
+    client_id: naughty
+
+production:
+  category_id:
+  encoding_preset_id:
+  ingest_recipe:
+    default:
+    other:
+
+  account_owner:
+    auth_token:
+    client_id:
+
+  intruder:
+    auth_token: some-secret
+    client_id: naughty

data/examples/category/create_update_delete_spec.rb

@@ -0,0 +1,100 @@
+require_relative './../spec_helper'
+
+module VzaarApi
+  describe 'Category: Create / Update / Delete' do
+
+    let(:described_class) { Category }
+
+    context 'when user is authenticated' do
+      before { setup_for :account_owner }
+
+      let(:attrs) { { name: 'new SDK category' } }
+
+      it 'creates, updates and deletes a resource' do
+        # name is required
+        expect{described_class.create}.to raise_error(
+          Error, "Invalid parameters: name is missing"
+        )
+
+        # create new category tree
+        category = described_class.create attrs
+        expect(category.name).to eq 'new SDK category'
+        expect(category.parent_id).to be_nil
+        expect(category.depth).to eq 0
+
+        subcategory = described_class.create attrs.merge(parent_id: category.id)
+        expect(subcategory.name).to eq 'new SDK category'
+        expect(subcategory.parent_id).to eq category.id
+        expect(subcategory.depth).to eq 1
+
+        subsubcategory = described_class.create attrs.merge(parent_id: subcategory.id)
+        expect(subsubcategory.name).to eq 'new SDK category'
+        expect(subsubcategory.parent_id).to eq subcategory.id
+        expect(subsubcategory.depth).to eq 2
+
+        expect(described_class.find(category.id).tree_children_count).to eq 2
+        expect(described_class.find(category.id).node_children_count).to eq 1
+        expect(described_class.find(subcategory.id).node_children_count).to eq 1
+
+        # can't create subcategories deeper than account will allow
+        expect{
+          described_class.create(attrs.merge(parent_id: subsubcategory.id))
+        }.to raise_error(
+          Error, 'Invalid parameters: Validation failed: Category depth must not exceed 3'
+        )
+
+        # perform update
+        name = "updated at: #{Time.now.utc}"
+        category.name = name
+        category.save
+        expect(category.name).to eq name
+
+        # move category and children to top level
+        subcategory.move_to_root = true
+        subcategory.save
+        expect(subcategory.parent_id).to be_nil
+        expect(subcategory.depth).to eq 0
+        expect(described_class.find(subsubcategory.id).depth).to eq 1
+        expect(described_class.find(category.id).node_children_count).to eq 0
+
+        expect(described_class.find(category.id).tree_children_count).to eq 0
+        expect(described_class.find(category.id).node_children_count).to eq 0
+        expect(described_class.find(subcategory.id).node_children_count).to eq 1
+
+        # move category and children to a new parent
+        subcategory.parent_id = category.id
+        subcategory.save
+        expect(subcategory.parent_id).to eq category.id
+        expect(subcategory.depth).to eq 1
+        expect(subsubcategory.depth).to eq 2
+
+        expect(described_class.find(category.id).tree_children_count).to eq 2
+        expect(described_class.find(category.id).node_children_count).to eq 1
+        expect(described_class.find(subcategory.id).node_children_count).to eq 1
+
+        # can't move if it will exceed category depth limit
+        new_cat = described_class.create(attrs)
+        new_cat.parent_id = subsubcategory.id
+        expect{new_cat.save}.to raise_error(
+          Error, 'Invalid parameters: Category depth must not exceed 3'
+        )
+
+        # delete categories
+        subsubcategory.delete
+        expect{ described_class.find(subsubcategory.id) }.to raise_error(
+            Error, 'Not found: Resource cannot be found')
+
+        # deleting parent deletes children
+        category.delete
+        expect{ described_class.find(category.id) }.to raise_error(
+            Error, 'Not found: Resource cannot be found')
+
+        expect{ described_class.find(subcategory.id) }.to raise_error(
+            Error, 'Not found: Resource cannot be found')
+
+        new_cat.delete # keep things tidy
+      end
+    end
+
+  end
+end

data/examples/category/list_spec.rb

@@ -0,0 +1,38 @@
+require_relative './../spec_helper'
+
+module VzaarApi
+  describe 'Category: List' do
+
+    let(:described_class) { Category }
+
+    context 'when user is authenticated' do
+      before { setup_for :account_owner }
+
+      describe '#each_item' do
+        it 'retrieves the resource list' do
+          ids = described_class.each_item.map(&:id)
+          expect(ids).not_to be_empty
+        end
+      end
+
+      describe '#paginate' do
+        let(:pager) { described_class.paginate(page: 2, per_page: 1) }
+        specify { expect(pager.first.count).to eq 1 }
+        specify { expect(pager.next.count).to eq 1 }
+        specify { expect(pager.previous.count).to eq 1 }
+        specify { expect(pager.last.count).to eq 1 }
+      end
+    end
+
+    context 'when user is not authenticated' do
+      before { setup_for :intruder }
+
+      it 'raises an error' do
+        pager = described_class.paginate
+        expect{ pager.first }.to raise_error(
+          Error, 'Authentication failed: Invalid credentials')
+      end
+    end
+
+  end
+end

data/examples/category/list_subtree_spec.rb

@@ -0,0 +1,40 @@
+require_relative './../spec_helper'
+
+module VzaarApi
+  describe 'Category: List' do
+
+    let(:described_class) { Category }
+
+    let(:category) { described_class.find(id) }
+    let(:id) { api_envs['category_id'] }
+
+    context 'when user is authenticated' do
+      before { setup_for :account_owner }
+
+      describe '#each_item' do
+        it 'retrieves the resource list' do
+          ids = category.subtree.each_item.map(&:id)
+          expect(ids).not_to be_empty
+        end
+      end
+
+      describe '#paginate' do
+        let(:pager) { category.subtree(page: 2, per_page: 1) }
+        specify { expect(pager.first.count).to eq 1 }
+        specify { expect(pager.next.count).to eq 1 }
+        specify { expect(pager.previous.count).to eq 1 }
+        specify { expect(pager.last.count).to eq 1 }
+      end
+    end
+
+    context 'when user is not authenticated' do
+      before { setup_for :intruder }
+
+      it 'raises an error' do
+        expect{ category.subtree }.to raise_error(
+          Error, 'Authentication failed: Invalid credentials')
+      end
+    end
+
+  end
+end

data/examples/category/lookup_spec.rb

@@ -0,0 +1,35 @@
+require_relative './../spec_helper'
+
+module VzaarApi
+  describe 'Category: Lookup' do
+
+    let(:described_class) { Category }
+    let(:id) { api_envs['category_id'] }
+
+    context 'when user is authenticated' do
+      before { setup_for :account_owner }
+
+      context 'and resource can be found' do
+        subject { described_class.find(id) }
+        specify { expect(subject.id).to eq id }
+      end
+
+      context 'and resource cannot be found' do
+        it 'raises an error' do
+          expect{ described_class.find(-1) }.to raise_error(
+            Error, 'Not found: Resource cannot be found')
+        end
+      end
+    end
+
+    context 'when user is not authenticated' do
+      before { setup_for :intruder }
+
+      it 'raises an error' do
+        expect{ described_class.find(id) }.to raise_error(
+          Error, 'Authentication failed: Invalid credentials')
+      end
+    end
+
+  end
+end

data/examples/encoding_preset/list_spec.rb

@@ -0,0 +1,38 @@
+require_relative './../spec_helper'
+
+module VzaarApi
+  describe 'Encoding preset: List' do
+
+    let(:described_class) { EncodingPreset }
+
+    context 'when user is authenticated' do
+      before { setup_for :account_owner }
+
+      describe '#each_item' do
+        it 'retrieves the resource list' do
+          ids = described_class.each_item.map(&:id)
+          expect(ids).not_to be_empty
+        end
+      end
+
+      describe '#paginate' do
+        let(:pager) { described_class.paginate(page: 2, per_page: 1) }
+        specify { expect(pager.first.count).to eq 1 }
+        specify { expect(pager.next.count).to eq 1 }
+        specify { expect(pager.previous.count).to eq 1 }
+        specify { expect(pager.last.count).to eq 1 }
+      end
+    end
+
+    context 'when user is not authenticated' do
+      before { setup_for :intruder }
+
+      it 'raises an error' do
+        pager = described_class.paginate
+        expect{ pager.first }.to raise_error(
+          Error, 'Authentication failed: Invalid credentials')
+      end
+    end
+
+  end
+end

data/examples/encoding_preset/lookup_spec.rb

@@ -0,0 +1,35 @@
+require_relative './../spec_helper'
+
+module VzaarApi
+  describe 'Encoding preset: Lookup' do
+
+    let(:described_class) { EncodingPreset }
+    let(:id) { api_envs['encoding_preset_id'] }
+
+    context 'when user is authenticated' do
+      before { setup_for :account_owner }
+
+      context 'and resource can be found' do
+        subject { described_class.find(id) }
+        specify { expect(subject.id).to eq id }
+      end
+
+      context 'and resource cannot be found' do
+        it 'raises an error' do
+          expect{ described_class.find(-1) }.to raise_error(
+            Error, 'Not found: Resource cannot be found')
+        end
+      end
+    end
+
+    context 'when user is not authenticated' do
+      before { setup_for :intruder }
+
+      it 'raises an error' do
+        expect{ described_class.find(id) }.to raise_error(
+          Error, 'Authentication failed: Invalid credentials')
+      end
+    end
+
+  end
+end

data/examples/ingest_recipe/create_update_delete_spec.rb

@@ -0,0 +1,70 @@
+require_relative './../spec_helper'
+
+module VzaarApi
+  describe 'Ingest recipe: Create / Update / Delete' do
+
+    let(:described_class) { IngestRecipe }
+    let(:id) { api_envs['ingest_recipe']['default'] }
+    let(:other_id) { api_envs['ingest_recipe']['other'] }
+
+    context 'when user is authenticated' do
+      before { setup_for :account_owner }
+
+      let(:attrs) do
+        {
+          name: 'new SDK recipe',
+          description: 'created by the SDK tests',
+          default: true,
+          frame_grab_time: 5.5,
+          multipass: false,
+          generate_animated_thumb: true,
+          generate_sprite: true,
+          use_watermark: true,
+          send_to_youtube: true,
+          encoding_preset_ids: [2, 3, 4]
+        }
+      end
+
+      it 'creates, updates and deletes a resource' do
+        # create new recipe
+        recipe = described_class.create attrs
+        expect(recipe.name).to eq 'new SDK recipe'
+        expect(recipe.default).to eq true
+        expect(recipe.encoding_presets.map(&:id)).to match_array [2, 3, 4]
+
+        # ensure previous default has changed
+        expect(described_class.find(id).default).to eq false
+
+        # perform update
+        name = "updated at: #{Time.now.utc}"
+        recipe.name = name
+        recipe.encoding_preset_ids = [4, 5, 6]
+        recipe.save
+        expect(recipe.name).to eq name
+        expect(recipe.encoding_presets.map(&:id)).to match_array [4, 5, 6]
+
+        # ensure you cannot unset current default
+        recipe.default = false
+        expect { recipe.save }.to raise_error(
+          Error, 'Invalid parameters: You cannot unflag your default ingest recipe')
+
+        # restore previous default
+        default = described_class.find(id)
+        expect(recipe.default).to eq false
+        default.default = true
+        default.save
+        expect(default.default).to eq true
+
+        # reload original recipe
+        recipe = described_class.find(recipe.id)
+        expect(recipe.default).to eq false
+
+        # delete recipe
+        recipe.delete
+        expect{ described_class.find(recipe.id) }.to raise_error(
+            Error, 'Not found: Resource cannot be found')
+      end
+    end
+
+  end
+end

data/examples/ingest_recipe/list_spec.rb

@@ -0,0 +1,38 @@
+require_relative './../spec_helper'
+
+module VzaarApi
+  describe 'Ingest recipe: List' do
+
+    let(:described_class) { IngestRecipe }
+
+    context 'when user is authenticated' do
+      before { setup_for :account_owner }
+
+      describe '#each_item' do
+        it 'retrieves the resource list' do
+          ids = described_class.each_item.map(&:id)
+          expect(ids).not_to be_empty
+        end
+      end
+
+      describe '#paginate' do
+        let(:pager) { described_class.paginate(page: 2, per_page: 1) }
+        specify { expect(pager.first.count).to eq 1 }
+        specify { expect(pager.next.count).to eq 1 }
+        specify { expect(pager.previous.count).to eq 1 }
+        specify { expect(pager.last.count).to eq 1 }
+      end
+    end
+
+    context 'when user is not authenticated' do
+      before { setup_for :intruder }
+
+      it 'raises an error' do
+        pager = described_class.paginate
+        expect{ pager.first }.to raise_error(
+          Error, 'Authentication failed: Invalid credentials')
+      end
+    end
+
+  end
+end