capgun 0.0.3 → 0.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    capgun (0.0.3)
+    capgun (0.1.0)
       activesupport (>= 2.3.9, < 4)
       faraday (~> 0.8)
       json (~> 1.6.6)
@@ -10,18 +10,18 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (3.2.12)
-      i18n (~> 0.6)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
       multi_json (~> 1.0)
     addressable (2.2.8)
     crack (0.3.1)
     diff-lcs (1.1.3)
-    faraday (0.8.5)
+    faraday (0.8.7)
       multipart-post (~> 1.1)
-    i18n (0.6.4)
-    json (1.6.7)
+    i18n (0.6.1)
+    json (1.6.8)
     multi_json (1.3.5)
-    multipart-post (1.1.5)
+    multipart-post (1.2.0)
     rake (0.9.2.2)
     rspec (2.9.0)
       rspec-core (~> 2.9.0)

data/HISTORY.md

@@ -1,14 +1,18 @@
 HISTORY
 =======
 
+0.1.0 - May 5, 2013
+--------------------------------------------------------------------------------
+* options for capture and estimate can be given in a block
+
 0.0.3 - April 17, 2013
---------------------------
+--------------------------------------------------------------------------------
 * Update docs
 
 0.0.2 - May 14, 2012
---------------------------
+--------------------------------------------------------------------------------
 * Basic implementation
 
 0.0.1 - April 4, 2012
---------------------------
+--------------------------------------------------------------------------------
 * Initial commit

data/lib/capgun/client.rb

@@ -1,5 +1,6 @@
 require 'json'
 require 'json/pure'
+require 'ostruct'
 require 'capgun/base'
 require 'capgun/account'
 require 'capgun/estimate'
@@ -36,7 +37,8 @@ module Capgun
     # @param [String] url A url that will be captured.
     # @param [Hash] options Additional options to the capture request.
     # @return [Capgun::Estimate] The estimate for the capture request.
-    def estimate(url, options = {})
+    def estimate(url, options = {}, &block)
+      options = with_options(options, &block)
       estimate = post("/v1/orders/estimate.json", options.merge(:url => url))
       Capgun::Estimate.new(estimate['order'])
     end
@@ -46,7 +48,8 @@ module Capgun
     # @param [String] url A url that will be captured.
     # @param [Hash] options Additional options to the capture request.
     # @return [Capgun::Order] The capture request order.
-    def capture(url, options = {})
+    def capture(url, options = {}, &block)
+      options = with_options(options, &block)
       order = post("/v1/orders.json", options.merge(:url => url))
       Capgun::Order.new(order['order'])
     end
@@ -77,6 +80,17 @@ module Capgun
       Capgun::Account.new(account['account'])
     end
 
+    private
+
+    def with_options(options, &block)
+      if block_given?
+        options = OpenStruct.new(options)
+        yield(options)
+        options = options.marshal_dump
+      end
+      options
+    end
+
   end
 
 end

data/lib/capgun/config.rb

@@ -37,6 +37,8 @@ module Capgun
       :proxy,
     ]
 
+    #ORDER_OPTIONS = Struct.new(:id, :url, :notify, :cost, :viewport, :packages, :images, :asset_urls, :options, :job)
+
     attr_accessor *VALID_OPTIONS_KEYS
 
     # When this module is extended, set all configuration options to their default values

data/lib/capgun/version.rb

@@ -8,12 +8,12 @@ module Capgun
 
     # @return [Integer]
     def self.minor
-      0
+      1
     end
 
     # @return [Integer]
     def self.patch
-      3
+      0
     end
 
     # @return [String, NilClass]

data/spec/capgun/client_spec.rb

@@ -74,6 +74,19 @@ describe Capgun::Client do
       estimate.cost.should == 1
     end
 
+    specify "estimate with options in a block" do
+      stub_request(:post, "https://api.capgun.io/v1/orders/estimate.json").
+        with(:body => '{"viewport":"1024x2048","packages":["images","viewport"],"url":"http://example.com/test"}',
+             :headers => {'Accept'=>'application/json', 'Authorization'=>'test', 'User-Agent'=>'Capgun.io Ruby Gem 0.0.3'}).
+        to_return(:status => 200, :body => fixture("estimate-with-options.json"), :headers => {})
+
+      estimate = Capgun.estimate("http://example.com/test", :viewport => "200x100") do |options|
+        options.packages = ['images', 'viewport']
+        options.viewport = '1024x2048'
+      end
+      estimate.cost.should == 3
+    end
+
     specify "urls are submitted for capture" do
       stub_request(:post, "https://api.capgun.io/v1/orders.json").
         with(:body => "{\"url\":\"http://example.com/test\"}",
@@ -85,6 +98,35 @@ describe Capgun::Client do
       order.cost.should == 1
     end
 
+    specify "capture with options can be in a block" do
+      stub_request(:post, "https://api.capgun.io/v1/orders.json").
+        with(:body => '{"packages":["images","viewport"],"viewport":"1024x2048","url":"http://example.com/test"}',
+             :headers => {'Accept'=>'application/json', 'Authorization'=>'test', 'User-Agent'=>'Capgun.io Ruby Gem 0.0.3'}).
+        to_return(:status => 200, :body => fixture("order-with-options.json"), :headers => {})
+
+      order = Capgun.capture("http://example.com/test", :packages => [ :images, :viewport ], :viewport => "1024x2048")
+      order.id.should == '4fd20a1288f560177600000a'
+      order.cost.should == 1
+      order.viewport.should == '1024x2048+0+0'
+      order.packages.should == ['base', 'images', 'viewport']
+    end
+
+    specify "capture with options can be in a block" do
+      stub_request(:post, "https://api.capgun.io/v1/orders.json").
+        with(:body => '{"viewport":"1024x2048","packages":["images","viewport"],"url":"http://example.com/test"}',
+             :headers => {'Accept'=>'application/json', 'Authorization'=>'test', 'User-Agent'=>'Capgun.io Ruby Gem 0.0.3'}).
+        to_return(:status => 200, :body => fixture("order-with-options.json"), :headers => {})
+
+      order = Capgun.capture("http://example.com/test", :viewport => "200x100") do |options|
+        options.packages = ['images', 'viewport']
+        options.viewport = '1024x2048'
+      end
+      order.id.should == '4fd20a1288f560177600000a'
+      order.cost.should == 1
+      order.viewport.should == '1024x2048+0+0'
+      order.packages.should == ['base', 'images', 'viewport']
+    end
+
     specify "showing a capture order" do
       stub_request(:get, "https://api.capgun.io/v1/orders/4fd20a1288f560177600000a.json").
         with(:headers => {'Accept'=>'application/json', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Authorization'=>'test', 'User-Agent'=>'Capgun.io Ruby Gem 0.0.3'}).

data/spec/fixtures/estimate-with-options.json

@@ -0,0 +1,68 @@
+{
+  "order": {
+    "url": "http://example.com/",
+    "notify": null,
+    "cost": 3,
+    "viewport": "1024x2048",
+    "images": {
+      "xlarge": "640x1280",
+      "small": "80x160",
+      "medium": "160x320",
+      "large": "320x640",
+      "excerpt": "400x150+0+0"
+    },
+    "packages": [
+      "base",
+      "images",
+      "viewport"
+    ],
+    "options": [
+      {
+        "package": "base"
+      },
+      {
+        "package": "images"
+      },
+      {
+        "package": "viewport"
+      },
+      {
+        "url": "http://example.com/"
+      },
+      {
+        "notify": null
+      },
+      {
+        "timeout": 5000
+      },
+      {
+        "image": {
+          "xlarge": "640x480"
+        }
+      },
+      {
+        "image": {
+          "small": "80x60"
+        }
+      },
+      {
+        "image": {
+          "medium": "160x120"
+        }
+      },
+      {
+        "image": {
+          "large": "320x240"
+        }
+      },
+      {
+        "image": {
+          "excerpt": "400x150+0+0"
+        }
+      },
+      {
+        "viewport": "1024x2048"
+      }
+    ]
+  }
+}

data/spec/fixtures/order-with-options.json

@@ -0,0 +1,74 @@
+
+{
+  "order": {
+    "id": "4fd20a1288f560177600000a",
+    "created_at": "2012-06-08T14:20:02+00:00",
+    "updated_at": "2012-06-08T14:20:02+00:00",
+    "url": "http://example.com:4567/",
+    "notify": null,
+    "cost": 1,
+    "viewport": "1024x2048+0+0",
+    "images": [
+      "640x480"
+    ],
+    "packages": [
+      "base",
+      "images",
+      "viewport"
+    ],
+    "options": [
+      {
+        "package": "base"
+      },
+      {
+        "package": "images"
+      },
+      {
+        "package": "viewport"
+      },
+      {
+        "url": "http://example.com:4567/"
+      },
+      {
+        "timeout": "5000"
+      },
+      {
+        "delay": "0"
+      },
+      {
+        "viewport": "1024x2048"
+      },
+      {
+        "image": {
+          "xlarge": "640x480"
+        }
+      },
+      {
+        "image": {
+          "small": "80x60"
+        }
+      },
+      {
+        "image": {
+          "medium": "160x120"
+        }
+      },
+      {
+        "image": {
+          "large": "320x240"
+        }
+      },
+      {
+        "image": {
+          "excerpt": "400x150+0+0"
+        }
+      }
+    ],
+    "job": {
+      "id": "4fd20a1288f5601776000012",
+      "state": "initialized",
+      "created_at": "2012-06-08T14:20:02+00:00",
+      "updated_at": "2012-06-08T14:20:08+00:00"
+    }
+  }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capgun
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-18 00:00:00.000000000 Z
+date: 2013-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -218,9 +218,11 @@ files:
 - spec/faraday/response_spec.rb
 - spec/fixtures/account.json
 - spec/fixtures/completed-order.json
+- spec/fixtures/estimate-with-options.json
 - spec/fixtures/estimate.json
 - spec/fixtures/job.json
 - spec/fixtures/notfound.json
+- spec/fixtures/order-with-options.json
 - spec/fixtures/order.json
 - spec/fixtures/unauthorized.json
 - spec/spec_helper.rb
@@ -238,7 +240,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3936620781114249947
+      hash: 2142080540201523708
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -247,7 +249,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3936620781114249947
+      hash: 2142080540201523708
 requirements: []
 rubyforge_project: capgun
 rubygems_version: 1.8.23
@@ -267,9 +269,11 @@ test_files:
 - spec/faraday/response_spec.rb
 - spec/fixtures/account.json
 - spec/fixtures/completed-order.json
+- spec/fixtures/estimate-with-options.json
 - spec/fixtures/estimate.json
 - spec/fixtures/job.json
 - spec/fixtures/notfound.json
+- spec/fixtures/order-with-options.json
 - spec/fixtures/order.json
 - spec/fixtures/unauthorized.json
 - spec/spec_helper.rb