zencoder 2.1.14 → 2.1.15

data/README.markdown

@@ -16,13 +16,15 @@ Tested on the following versions of Ruby:
 
 ## Getting Started
 
-The first thing you'll need to interact with the Zencoder API is your API key. You can use your API key in one of two ways. The first, and in our opinion the best, is to set it and forget it on the Zencoder module like so:
+The first thing you'll need to interact with the Zencoder API is your API key. You can use your API key in one of three ways. The first and easiest is to set it and forget it on the Zencoder module like so:
 
     Zencoder.api_key = 'abcd1234'
 
-Alternatively you can pass your API key in every request, but who wants to do that?
+Alternatively, you can use an environment variable:
 
-We'll include examples of both ways throughout this document.
+    ENV['ZENCODER_API_KEY'] = 'abcd1234'
+
+You can also pass your API key in every request, but who wants to do that?
 
 ## Responses
 
@@ -51,18 +53,9 @@ Or you can specify them as a string, which we'll just pass along as the request
 
 There's more you can do on jobs than anything else in the API. The following methods are available: `list`, `create`, `details`, `progress`, `resubmit`, `cancel`, `delete`.
 
-### list
-
-By default the jobs listing is paginated with 50 jobs per page and sorted by ID in descending order. You can pass two parameters to control the paging: `page` and `per_page`.
-
-    Zencoder::Job.list
-    Zencoder::Job.list(:per_page => 10)
-    Zencoder::Job.list(:per_page => 10, :page => 2)
-    Zencoder::Job.list(:per_page => 10, :page => 2, :api_key => 'abcd1234')
-
 ### create
 
-The hash you pass to the `create` method should be encodable to the [JSON you would pass to the Job creation API call on Zencoder](http://zencoder.com/docs/api/#encoding-job).
+The hash you pass to the `create` method should be encodable to the [JSON you would pass to the Job creation API call on Zencoder](http://zencoder.com/docs/api/#encoding-job). We'll auto-populate your API key if you've set it already.
 
     Zencoder::Job.create({:input => 's3://bucket/key.mp4'})
     Zencoder::Job.create({:input => 's3://bucket/key.mp4',
@@ -70,6 +63,21 @@ The hash you pass to the `create` method should be encodable to the [JSON you wo
                                         :url => 's3://bucket/key_output.webm'}]})
     Zencoder::Job.create({:input => 's3://bucket/key.mp4', :api_key => 'abcd1234'})
 
+This returns a Zencoder::Response object. The body includes a Job ID, and one or more Output IDs (one for every output file created).
+
+    response = Zencoder::Job.create({:input => 's3://bucket/key.mp4'})
+    response.code           # => 201
+    response.body['id']      # => 12345
+
+### list
+
+By default the jobs listing is paginated with 50 jobs per page and sorted by ID in descending order. You can pass two parameters to control the paging: `page` and `per_page`.
+
+    Zencoder::Job.list
+    Zencoder::Job.list(:per_page => 10)
+    Zencoder::Job.list(:per_page => 10, :page => 2)
+    Zencoder::Job.list(:per_page => 10, :page => 2, :api_key => 'abcd1234')
+
 ### details
 
 The number passed to `details` is the ID of a Zencoder job.
@@ -102,7 +110,7 @@ The number passed to `delete` is the ID of a Zencoder job.
 
 ### progress
 
-Please note that the number passed to `progress` is the output file ID.
+*Important:* the number passed to `progress` is the output file ID, not the Job ID.
 
     Zencoder::Output.progress(1)
     Zencoder::Output.progress(1, :api_key => 'abcd1234')

data/lib/zencoder.rb

@@ -6,6 +6,15 @@ require 'timeout'
 # Gems
 require 'active_support' # JSON and XML parsing/encoding
 
+# ActiveSupport 3.0
+begin
+  require 'active_support/core_ext/class'
+  require 'active_support/core_ext/hash'
+  require 'active_support/json'
+  require 'active_support/xml'
+rescue LoadError
+end
+
 # Zencoder
 require 'zencoder/extensions'
 require 'zencoder/zencoder'

data/lib/zencoder/version.rb

@@ -1,3 +1,3 @@
 class Zencoder
-  GEM_VERSION = '2.1.14'
+  GEM_VERSION = '2.1.15'
 end

data/lib/zencoder/zencoder.rb

@@ -1,10 +1,14 @@
 class Zencoder
 
   cattr_accessor :base_url
-  cattr_accessor :api_key
+  cattr_writer :api_key
 
-  self.base_url = 'https://app.zencoder.com/api'
+  def self.api_key
+    @@api_key || ENV['ZENCODER_API_KEY']
+  end
 
+  self.base_url = 'https://app.zencoder.com/api'
+  
   def self.encode(content, format=nil)
     if content.is_a?(String)
       content

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: zencoder
 version: !ruby/object:Gem::Version 
+  hash: 21
   prerelease: false
   segments: 
   - 2
   - 1
-  - 14
-  version: 2.1.14
+  - 15
+  version: 2.1.15
 platform: ruby
 authors: 
 - Nathan Sutton
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-31 00:00:00 -05:00
+date: 2010-09-10 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -33,9 +36,11 @@ dependencies:
   name: shoulda
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -45,9 +50,11 @@ dependencies:
   name: mocha
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -57,9 +64,11 @@ dependencies:
   name: webmock
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -100,23 +109,27 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: zencoder
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Zencoder <http://zencoder.com> integration library.