blitline 1.4.0 → 2.0.1

data/Gemfile

@@ -7,9 +7,8 @@ source "http://rubygems.org"
 # Include everything needed to run rake, tests, features, etc.
 group :development do
   gem "shoulda", ">= 0"
-  gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.6.4"
   gem "rcov", ">= 0"
 end
 
-gem 'yajl-ruby', :require => 'yajl'
+gem 'multi_json'

data/Gemfile.lock

@@ -6,17 +6,16 @@ GEM
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
+    multi_json (1.3.6)
     rake (0.9.2.2)
     rcov (0.9.11)
     shoulda (2.11.3)
-    yajl-ruby (1.1.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
   jeweler (~> 1.6.4)
+  multi_json
   rcov
   shoulda
-  yajl-ruby

data/README.rdoc

@@ -1,8 +1,8 @@
-Getting Started
+# Getting Started
 
 You must first have a Blitline.com account to successfully use the gem. You can obtain one (free) by going to http://www.blitline.com
 
-Once you have your account, you will need to find you ACCOUNT_ID which you can get by logging in and clicking on the *Account* tab.
+Once you have your account, you will need to find you APPLICATION_ID which you can get by logging in and clicking on the *Account* tab.
 
 
 In you application environment, install the Blitline gem or add the Blitline gem to your Gemfile
@@ -13,24 +13,57 @@ or...if you have a Gemfile
 
     gem 'blitline'
 
+*Note: We have changed our recommended method of submitting Blitline jobs to just submitting job hashes instead of building
+objects through an object model. This is because the Blitline API changes and evolves faster than people can/want to update their gems. 
+Old ways will still work, they will just not be used in documentation going forward. Since Blitline works via a JSON API, it is
+easier to understand the hierarchy of the job when viewed as a hash. (You can find some old object based documentation [here](https://github.com/blitline-dev/blitline/wiki))*
+
+Learn more about [job hashes](http://www.blitline.com/docs/api) and see some related JSON [examples](http://www.blitline.com/docs/examples)
+
+## The new preferred method is as follows:
+
 Once the gem is installed, you can start a Rails console and try the following:
 
-    $ job = Blitline::Job.new("http://www.google.com/logos/2011/yokoyama11-hp.jpg") # My source file to manipulate
-    $ job.application_id = "ACCOUNT_ID" # This ACCOUNT_ID needs to be your account ID from Blitline which you got from Blitline.com above
-    $ blur_function = job.add_function("blur", {:radius => 1}) # Add a blur function
-    $ blur_function.add_save("my_first_image") # Adds a save function (which takes a string parameter which is what the image is identified as on callback/polling)
     $ blitline_service = Blitline.new
-    $ blitline_service.jobs << job # Push job into service
+    $ blitline_service.add_job_via_hash({
+          "application_id"=>"YOUR_APP_ID",
+          "src"=>"http://cdn.blitline.com/filters/boys.jpeg",
+          "functions"=>[
+              {
+                  "name"=>"resize_to_fit",
+                  "params"=>{
+                      "width"=>100
+                  },
+                  "save"=>{
+                      "image_identifier"=>"MY_CLIENT_ID"
+                  }
+              }
+          ]
+      })
     $ blitline_service.post_jobs
 
-And you will get JSON back describing where the resulting image will be located
-There are many more things you can do with images (including pushing them to your own S3 buckets).
+The resulting JSON will look something like:
+
+```js
+{"results":{"images":[{"image_identifier":"MY_CLIENT_ID", "s3_url":"http://s3.amazonaws.com/blitline/9393939393/99/6CPGskk11mM-B8zaCYUJzqbw.jpg"}] ,"job_id":"4JVyFJBIhlpHNXLK-YClq5g"}}
+```
 
+This JSON contains:
 
-You can find documentation about Blitline.com and it's services by following the links below
-Further reading:
+- Any error information that may have happened with the submit
+- A list of images
+  - Each image has an `image_indentifier`, which is the `image_identifier` you used in the `save` params.
+  - Each image also has an `s3_url` which is the final destination of the image (once it is done processing).
+
+### Important! ###
+This result does not indicate that the job is done! The job has been put on a queue and will be done shortly. The best
+way to identify when the job is completed is by adding a `postback_url` to the job hash and we will call back that url
+when we have completed the image processing.
+
+
+The example above is a trivial (and pretty uninteresting) demonstration of how to use the Blitline gem. You can find documentation about Blitline.com and it's services by following the links below
 
 * [Quickstart](http://www.blitline.com/docs/quickstart)
 * [Blitline Blog](http://blitline.tumblr.com)
-
+* [See all the available functions](http://www.blitline.com/docs/functions)
 

data/VERSION

@@ -1 +1 @@
-1.4.0
+2.0.1

data/blitline.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "blitline"
-  s.version = "1.4.0"
+  s.version = "2.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Blitline LLC"]
-  s.date = "2012-10-12"
+  s.date = "2012-11-22"
   s.description = "The blitline gems provides a simple easy wrapper to the Blitline.com web api"
   s.email = "support@blitline.com"
   s.extra_rdoc_files = [
@@ -46,22 +46,19 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<yajl-ruby>, [">= 0"])
+      s.add_runtime_dependency(%q<multi_json>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
-      s.add_dependency(%q<yajl-ruby>, [">= 0"])
+      s.add_dependency(%q<multi_json>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
-    s.add_dependency(%q<yajl-ruby>, [">= 0"])
+    s.add_dependency(%q<multi_json>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
     s.add_dependency(%q<rcov>, [">= 0"])
   end

data/lib/blitline.rb

@@ -1,5 +1,5 @@
 class Blitline
-  require 'yajl'
+  require 'multi_json'
   require 'blitline/attribute_jsonizer'
   require 'blitline/function'
   require 'blitline/job'
@@ -33,15 +33,24 @@ class Blitline
     @jobs << job
   end
 
+  def add_job_via_hash(hash)
+    @jobs << hash
+  end
+
   def validate
     raise "At least 1 job must be present to run" if @jobs.length < 1
-    @jobs.each { |j| j.validate }
+    @jobs.each do |j|
+      unless j.is_a?(Hash)
+        j.validate
+      end
+    end
   end
 
   def post_jobs
     validate
-    result = Blitline::HttpPoster.post("http://api.blitline.com/job", { :json => Yajl::Encoder.encode(@jobs)})
-    return Yajl::Parser.parse(result)
+#    puts MultiJson.dump(@jobs).inspect
+    result = Blitline::HttpPoster.post("http://api.blitline.com/job", { :json => MultiJson.dump(@jobs)})
+    return MultiJson.load(result)
   end
 
 end

data/lib/blitline/attribute_jsonizer.rb

@@ -1,18 +1,18 @@
 module AttributeJsonizer
-  require 'yajl'
+  require 'multi_json'
 
   def add_jsonizable_attribute(json_name, jsonizeable_object)
     self.class.module_eval { attr_accessor json_name.to_sym}
     self.send("#{json_name.to_s}=", jsonizeable_object)
   end
 
-  def to_json
+  def to_json(options)
     json_hash = {}
     self.instance_variables.each do |iv|
       key = iv
       value = self.instance_variable_get(iv)
       json_hash[key.to_s.gsub("@","")] = value unless value.kind_of?(Array) && value.length == 0 #Bail on empty arrays
     end
-    Yajl::Encoder.encode(json_hash)
+    MultiJson.dump(json_hash)
   end
 end

data/test/test_blitline.rb

@@ -1,4 +1,5 @@
 require 'helper'
+require 'multi_json'
 
 class TestBlitline < Test::Unit::TestCase
 
@@ -58,7 +59,7 @@ class TestBlitline < Test::Unit::TestCase
     job.application_id = "foo"
     job.add_jsonizable_attribute("pre_process", { "move_original" => { "s3_destination" => Blitline::S3Destination.new("my_key","my_bucket")}})
   
-    results = Yajl::Encoder.encode(job)
+    results = MultiJson.dump(job)
     assert_not_nil results["pre_process"]
     assert results == '{"src":"http://ww.foo.com","functions":[{"name":"blue","save":{"image_identifier":"my_image"}}],"application_id":"foo","pre_process":{"move_original":{"s3_destination":{"key":"my_key","bucket":"my_bucket","headers":{}}}}}'
   end

data/test/test_service.rb

@@ -2,7 +2,7 @@ require 'helper'
 
 class TestService < Test::Unit::TestCase
   if ENV['BLITLINE_APPLICATION_ID']
-    require 'yajl'
+    require 'multi_json'
     SAMPLE_IMAGE_SRC = "http://www.google.com/intl/en_com/images/srpr/logo3w.png"
 
     should "be able to commit a simple job to service" do
@@ -24,7 +24,30 @@ class TestService < Test::Unit::TestCase
       function.add_save("my_image", "grumpy_squirrel/frame2.jpg", "bltemp", { "x-amz-meta-foo" => "bar", "x-amz-meta-baz" => "qux"})
       blitline.jobs << job
       returned_values = blitline.post_jobs
-      puts "----", returned_values.inspect
+      assert(returned_values.length > 0, "No results returned")
+      assert(returned_values['results'][0]['images'].length > 0, "No images returned")
+    end
+
+    should "be able to add job via hash" do
+      blitline = Blitline.new
+      blitline.add_job_via_hash({
+          "application_id"=>"#{ENV['BLITLINE_APPLICATION_ID']}",
+          "src"=>"http://cdn.blitline.com/filters/boys.jpeg",
+          "functions"=>[
+              {
+                  "name"=>"resize_to_fit",
+                  "params"=>{
+                      "width"=>100
+                  },
+                  "save"=>{
+                      "image_identifier"=>"MY_CLIENT_ID"
+                  }
+              }
+          ]
+      })
+
+
+      returned_values = blitline.post_jobs
       assert(returned_values.length > 0, "No results returned")
       assert(returned_values['results'][0]['images'].length > 0, "No images returned")
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blitline
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,10 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-12 00:00:00.000000000 Z
+date: 2012-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: yajl-ruby
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -43,22 +43,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
@@ -133,7 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 334560143
+      hash: 71690003
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: