everybit 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in everybit.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2013- Everybit Media Services, Inc. (https://everybit.co)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,281 @@
+![Everybit Logo](http://dev.everybit.co/wp-content/themes/everybit/img/everybit-logo.png)
+
+This gem encapsulates the functionality needed to access the [Everybit](http://dev.everybit.co) Streaming Media API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'everybit'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself with the usual gem install command:
+
+    $ gem install everybit
+
+## Requirements
+
+* Ruby 1.9.3
+* rest-client, multi_json
+
+## Usage
+
+Detailed documentation for communicating with the Everybit Streaming Media API is available [here](http://docs.everybit.co). The information in this readme is only a brief introduction. If you have a specific problem with this gem you can [open an issue](https://github.com/everybit/everybit-ruby/issues) or, for more specific help with using the API in general, you can visit our dedicated [support site](https://everybit.zendesk.com/home).
+
+### Preparation
+
+All communication with the Everybit Streaming Media API must be accompanied by your Everybit API key. This key is available in the My Account section of our Dashboard Media Management Portal and is randomly generated upon successful registration.
+
+To setup the `everybit` gem with your API key, simply set it in the global `Everybit` object:
+
+```ruby
+Everybit.api_key = '1a2b3c4d5e6f7g8h9i'
+```
+
+You can also view and change the base URL to which the gem will submit your media's details:
+
+```ruby
+Everybit.api_base
+# => 'https://api.everybit.co'
+
+Everybit.api_base = 'http://api.example.com'
+# => 'https://api.example.com'
+```
+
+### Accounts
+
+The library allows you to retrieve the details for the account attached to the API key provided:
+
+```ruby
+Everybit.api_key = 'YOUR_API_KEY'
+acct = Everybit::Account.retrieve
+
+acct.code
+# => 200
+
+acct.status # this is the status of the request, not the account itself
+# => true
+
+acct[:uuid]       # => '787c8956-1857-4771-9d4e-b99b4dedfeae'
+acct[:email]      # => 'jsmith@example.com'
+acct[:username]   # => 'jsmith'
+acct[:first_name] # => 'John'
+acct[:last_name]  # => 'Smith'
+```
+
+### Videos
+
+#### Status
+
+To check the status of a video that's been uploaded for encoding and conversion:
+
+```ruby
+Everybit.api_key = 'YOUR_API_KEY'
+video = Everybit::Video.status('UUID_OF_VIDEO')
+
+video.code
+# => 200
+
+video.status # this is the status of the request, not the video itself
+# => true
+
+video[:uuid]           # => 'UUID_OF_VIDEO'
+video[:processing]     # => true
+video[:progress]       # => 50
+video[:completed]      # => false
+video[:completed_date] # => ''
+```
+
+#### Details
+
+To request the details of a video that's completed encoding and conversion:
+
+```ruby
+Everybit.api_key = 'YOUR_API_KEY'
+video = Everybit::Video.details('UUID_OF_VIDEO')
+
+video.code
+# => 200
+
+video.status # this is the status of the request, not the video itself
+# => true
+
+video[:created_date]      # => 1362636380 (milliseconds since epoch)
+video[:external_callback] # => the callback url provided during create request
+video[:lat]               # => 40.714353
+video[:lon]               # => -74.005973
+video[:owner_uuid]        # => uuid of the user that created the video
+video[:source_url]        # => the source url provided during create request
+video[:summary]           # => 'A short description about the video.'
+video[:title]             # => 'Video Title'
+video[:play_count]        # => number of times this video has been played
+video[:data_consumed]     # => amount of data streamed for this video
+video[:tags]              # => [array of tags]
+video[:visibility]        # => 'public|protected|private'
+video[:last_updated]      # => 1362636380 (milliseconds since epoch)
+video[:uuid]              # => UUID_OF_VIDEO
+video[:thumbnail]         # => path to a thumbnail of the video's full size hold frame image
+video[:original_file]     # => path to original file uploaded during create request
+video[:player_url]        # => url to the video's player
+video[:media_info]        # => {HASH OF DETAILED MEDIA INFO}
+video[:player_attributes] # => {HASH OF CUSTOMIZABLE PLAYER ATTRIBUTES}
+video[:versions]          # => [ARRAY OF HASHES FOR EACH VERSION CREATED DURING ENCODING]
+```
+
+#### Create
+
+When you need to upload a new video for encoding and conversion, use the create method. Besides your api key, there are eight additional pieces of information that can be sent in a create request:
+
+1. title (required)
+2. summary
+3. tags
+4. lat
+5. lon
+6. visibility (required)
+7. source_file (required)
+8. callback_url (required)
+
+```ruby
+Everybit.api_key = 'YOUR_API_KEY'
+
+video_details = {
+  title: 'Dolphin Training',
+  summary: 'How to train your dolphin like a pro.',
+  tags: ['dolphin', 'training'],
+  lat: 40.714353,
+  lon: -74.005973,
+  visibility: 'public',
+  source_file: 'http://example.com/dolphin.mp4',
+  callback_url: 'http://example.com/everybit_callback'
+}
+
+video = Everybit::Video.create(video_details)
+```
+
+The request will return one of two responses. A success response if the video has successfully started encoding and conversion, or an error response if something prevented the video from being created:
+
+    Success response:
+    {
+      "code": 200,
+      "status": true,
+      "data": {
+        "uuid": UUID
+      }
+    }
+
+    Error response:
+    {
+      "code": 400,
+      "status": false,
+      "data": {
+        "error" "specific error message here"
+      }
+    }
+
+#### Update
+
+When you need to change the attributes for a video that's completed encoding, use the update method.
+
+```ruby
+Everybit.api_key = 'YOUR_API_KEY'
+
+video_updates = {
+  lat: 39.737567,
+  lon: -104.984718,
+  summary: 'updated summary',
+  title: 'updated title',
+  tags: ['updated', 'tags'],
+  visibility: 'public|protected|private',
+  player_attributes: {
+    template_name: "default",
+    width: 640,
+    height: 360,
+    hold_frame: "http://example.com/custom_hold_frame",
+    show_hold_frame: true,
+    sharing_enabled: true,
+    show_email_share: true,
+    show_embed_share: true,
+    show_social_share: true,
+    auto_play: false,
+    scaling: "fit",
+    fade_in_speed: 0,
+    fade_out_speed: 0,
+    start_time: 0.000,
+    duration: 0.000,
+    show_controls: true,
+    auto_hide_controls: true,
+    auto_hide_controls_fullscreen_only: false,
+    auto_hide_controls_delay: 10000,
+    hardware_accelerated: false,
+    background_color: "#000000",
+    background_gradient: "low",
+    time_color: "#01DAFF",
+    duration_color: "#FFFFFF",
+    progress_color: "#015B7A",
+    progress_gradient: "medium",
+    buffer_color: "#6C9CBC",
+    buffer_gradient: "none",
+    slider_color: "#000000",
+    slider_gradient: "none",
+    button_color: "#889AA4",
+    button_over_color: "#92B2BD",
+    volume_slider_color: "#000000",
+    volume_color: "#000000",
+    volume_slider_gradient: "none",
+    time_background_color: "#555555",
+    time_border_color: "#FFFFFF"
+  }
+}
+
+video = Everybit::Video.update(video_updated)
+```
+
+The response from an update request is the same as a details response, except it will contain your updated details.
+
+#### Delete
+
+To delete a video that's completed encoding and conversion:
+
+```ruby
+Everybit.api_key = 'YOUR_API_KEY'
+video = Everybit::Video.delete('UUID_OF_VIDEO')
+```
+
+The request will return one of two responses. A success response if the video was successfully deleted, or an error response if something prevented the video from being deleted:
+
+    Success response:
+    {
+      "code": 200,
+      "status": true,
+      "data": {
+        "message": "your video was deleted successfully"
+      }
+    }
+
+    Error response:
+    {
+      "code": 400,
+      "status": false,
+      "data": {
+        "error": "specific error message here"
+      }
+    }
+
+## Tests
+
+All tests are located in the `spec` directory and are written using [Minitest's](http://docs.seattlerb.org/minitest/) spec (expectation) syntax. They've been divided into test files according to the resource under test. So, for example, all the tests for the Account class can be found in `spec/account_spec.rb`. You can run all tests with the usual `rake` command with no arguments. If you'd like to run only one set of tests, you can specify them using the minitest namespace for that resource. e.g. `rake minitest:account`.
+
+A list of available rake tasks can be output with the usual `rake -T` command.
+
+## 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
+
+If you're developing locally, the gem's Rakefile includes Bundler's gem tasks. So calling `rake build` will build the gem and `rake install` will first build and then install the gem locally. A gem binary called `everybit-console` has been included to make local testing a little easier. It will launch an irb session with the `everybit` gem already required.

data/Rakefile

@@ -0,0 +1,32 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+desc 'Generate gem documentation'
+task :doc do
+  system 'rm -rf doc/'
+  system 'rdoc --exclude=/spec/'
+end
+
+namespace :minitest do
+  Rake::TestTask.new(:all) do |t|
+    t.libs << 'spec'
+    t.test_files = FileList['spec/*_spec.rb']
+  end
+
+  Rake::TestTask.new(:misc) do |t|
+    t.libs << 'spec'
+    t.test_files = ['spec/misc_spec.rb']
+  end
+
+  Rake::TestTask.new(:account) do |t|
+    t.libs << 'spec'
+    t.test_files = ['spec/account_spec.rb']
+  end
+
+  Rake::TestTask.new(:video) do |t|
+    t.libs << 'spec'
+    t.test_files = ['spec/video_spec.rb']
+  end
+end
+
+task :default => 'minitest:all'

data/bin/everybit-console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  ' -r irb/completion'
+libs << " -r #{File.dirname(__FILE__) + '/../lib/everybit'}"
+puts 'Loading everybit gem'
+exec "#{irb} #{libs} --simple-prompt"

data/everybit.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'everybit/version'
+
+Gem::Specification.new do |gem|
+
+  #-- author info
+  gem.authors           = ['Dominic Giglio']
+  gem.email             = ['humanshell@gmail.com']
+  gem.homepage          = 'http://dev.everybit.co'
+
+  #-- gem info
+  gem.name              = 'everybit'
+  gem.version           = Everybit::VERSION
+  gem.summary           = %q{Access Everybit API}
+  gem.description       = %q{This gem defines methods for controlling your media through Everybit's API.}
+  gem.files             = `git ls-files`.split($/)
+  gem.executables       = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files        = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths     = ['lib']
+  gem.rubyforge_project = 'everybit'
+
+  #-- release dependencies
+  gem.add_dependency 'rest-client', '~> 1.6'
+  gem.add_dependency 'multi_json', '~> 1.5'
+
+  #-- development dependencies
+  gem.add_development_dependency('minitest')
+  gem.add_development_dependency('turn')
+  
+end

data/lib/everybit/account.rb

@@ -0,0 +1,8 @@
+module Everybit
+  class Account < Resource
+    def self.retrieve(params={})
+      res = Everybit.request(:get, '/v1/account', params)
+      self.new(res[:code], res[:status], res[:data])
+    end
+  end
+end

data/lib/everybit/collection.rb

@@ -0,0 +1,17 @@
+module Everybit
+  class Collection
+
+    attr_reader :code, :status, :data
+
+    def initialize(code, status, data)
+      @code   = code
+      @status = status
+      @data   = data
+    end
+
+    def inspect()
+      "#<#{self.class}> DATA: #{@data}"
+    end
+
+  end
+end

data/lib/everybit/errors/authentication_error.rb

@@ -0,0 +1,4 @@
+module Everybit
+  class AuthenticationError < EverybitError
+  end
+end

data/lib/everybit/errors/everybit_error.rb

@@ -0,0 +1,20 @@
+module Everybit
+  class EverybitError < StandardError
+    attr_reader :message
+    attr_reader :http_status
+    attr_reader :http_body
+    attr_reader :json_body
+
+    def initialize(message=nil, http_status=nil, http_body=nil, json_body=nil)
+      @message = message
+      @http_status = http_status
+      @http_body = http_body
+      @json_body = json_body
+    end
+
+    def to_s
+      status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
+      "#{status_string}#{@message}"
+    end
+  end
+end

data/lib/everybit/everybit_object.rb

@@ -0,0 +1,32 @@
+module Everybit
+  class EverybitObject
+
+    attr_reader :code, :status
+
+    def initialize(code, status, data)
+      @code   = code
+      @status = status
+      @data   = data
+    end
+
+    def [](k)
+      @data[k]
+    end
+
+    def []=(k, v)
+      @data[k] = v
+    end
+
+    def to_s
+      MultiJson.dump(@data)
+    end
+
+    def to_json(*a)
+      @data
+    end
+
+    def inspect()
+      "#<#{self.class}:#{@data[:uuid]}> JSON: #{@data}"
+    end
+  end
+end

data/lib/everybit/modules/createable.rb

@@ -0,0 +1,13 @@
+module Everybit
+  module Createable
+    module ClassMethods
+      def create(params={})
+        retrieve(:post, url, params)
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+  end
+end

data/lib/everybit/modules/deleteable.rb

@@ -0,0 +1,14 @@
+module Everybit
+  module Deleteable
+    module ClassMethods
+      def delete(uuid, params={})
+        raise ArgumentError, 'A uuid was not provided.' unless uuid
+        retrieve(:delete, delete_url(uuid), params)
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+  end
+end

data/lib/everybit/modules/listable.rb

@@ -0,0 +1,15 @@
+module Everybit
+  module Listable
+    module ClassMethods
+      def all(params={})
+        res = Everybit.request(:get, url, params)
+        res[:data].map! { |elem| self.new(res[:code], res[:status], elem) }
+        Collection.new(res[:code], res[:status], res[:data])
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+  end
+end

data/lib/everybit/modules/updateable.rb

@@ -0,0 +1,28 @@
+module Everybit
+  module Updateable
+    module InstanceMethods
+      def save(params={})
+        @data.merge! params
+        res = Everybit.request(:put, update_url(@data[:uuid]), @data)
+        @code = res[:code]
+        @status = res[:status]
+
+        if res[:status]
+          @data[:message] = res[:data][:message]
+        else
+          @data[:error] = res[:data][:error]
+        end
+
+        self
+      end
+
+      def update_url(uuid)
+        "#{self.class.url}/#{uuid}"
+      end
+    end
+    
+    def self.included(receiver)
+      receiver.send :include, InstanceMethods
+    end
+  end
+end

data/lib/everybit/resource.rb

@@ -0,0 +1,21 @@
+module Everybit
+  class Resource < EverybitObject
+
+    def self.class_name
+      self.name.split('::')[-1]
+    end
+    
+    def self.url()
+      if self == Resource
+        raise NotImplementedError.new('Resource is an abstract class. You should perform actions on its subclasses.')
+      end
+      "/v1/#{CGI.escape(class_name.downcase)}s"
+    end
+
+    def self.retrieve(method, url, params={}, headers={})
+      res = Everybit.request(method, url, params, headers)
+      self.new(res[:code], res[:status], res[:data])
+    end
+
+  end
+end

data/lib/everybit/version.rb

@@ -0,0 +1,3 @@
+module Everybit
+  VERSION = '0.1.0'
+end

data/lib/everybit/video.rb

@@ -0,0 +1,33 @@
+module Everybit
+  class Video < Resource
+    include Everybit::Listable
+    include Everybit::Deleteable
+    include Everybit::Createable
+    include Everybit::Updateable
+
+    def self.status(uuid, params={})
+      raise ArgumentError, 'A uuid was not provided.' unless uuid
+      retrieve(:get, status_url(uuid), params)
+    end
+
+    def self.details(uuid, params={})
+      raise ArgumentError, 'A uuid was not provided.' unless uuid
+      retrieve(:get, details_url(uuid), params)
+    end
+
+    private
+
+    def self.status_url(uuid)
+      url + "/#{uuid}/status"
+    end
+
+    def self.details_url(uuid)
+      url + "/#{uuid}"
+    end
+
+    def self.delete_url(uuid)
+      url + "/#{uuid}"
+    end
+
+  end
+end