capgun 0.0.1 → 0.0.3

data/.gitignore

@@ -2,3 +2,4 @@
 pkg/
 .*.swp
 .swp
+coverage/

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format documentation
+--backtrace

data/Gemfile

@@ -1,10 +1,3 @@
 source 'https://rubygems.org'
 
-gem 'rake'
-
-group :development do
-end
-
-group :test do
-  gem 'rspec'
-end
+gemspec

data/Gemfile.lock

@@ -1,7 +1,27 @@
+PATH
+  remote: .
+  specs:
+    capgun (0.0.3)
+      activesupport (>= 2.3.9, < 4)
+      faraday (~> 0.8)
+      json (~> 1.6.6)
+      multi_json (~> 1.3)
+
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    addressable (2.2.8)
+    crack (0.3.1)
     diff-lcs (1.1.3)
+    faraday (0.8.5)
+      multipart-post (~> 1.1)
+    i18n (0.6.4)
+    json (1.6.7)
+    multi_json (1.3.5)
+    multipart-post (1.1.5)
     rake (0.9.2.2)
     rspec (2.9.0)
       rspec-core (~> 2.9.0)
@@ -11,10 +31,22 @@ GEM
     rspec-expectations (2.9.1)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.9.0)
+    simplecov (0.6.4)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    webmock (1.8.7)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+    yard (0.8.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  capgun!
   rake
   rspec
+  simplecov
+  webmock
+  yard

data/HISTORY.md

@@ -1,3 +1,14 @@
-2012-04-11
-==================
-  * Initial commit
+HISTORY
+=======
+
+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/LICENSE.md

@@ -0,0 +1,26 @@
+(The MIT License)
+
+(From Twitter Gem http://github.com/jnunemaker/twitter)
+Copyright (c) 2011 John Nunemaker, Wynn Netherland, Erik Michaels-Ober, Steve Richert
+
+(Capgun Gem)
+Copyright (c) 2012 Mike Mondragon (mikemondragon@gmail.com)
+
+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

@@ -1,5 +1,307 @@
-Capgun
-======
+# capgun.io API gem
 
-Place holder gem for Ruby gem that will be created to interface the capgun.io
-web thumb service.
+A Ruby wrapper for the capgun.io web thumb service API
+
+## Installation
+
+  gem install capgun
+
+## Credits
+
+The capgun's gem organization is based (and inspired!) by jnunemaker's
+[https://github.com/jnunemaker/twitter][twitter gem], see LICENSE.md.
+jnunemaker's style of coding is very elegant in its simplicity and a joy to
+read.
+
+## Configuration
+
+The gem is easy to configure with the global configure block.  Its most basic
+invocation needs to set the authorization token issued to the API.
+
+```ruby
+Capgun.configure do |config|
+  config.auth_token = "YOUR-AUTH-TOKEN"
+end
+```
+
+The configuration has the following attributes to be assigned values.
+
+* adapter
+* connection_options
+* endpoint
+* gateway
+* auth_token
+* user_agent
+* proxy
+
+## Actions
+
+There are five actions exposed by the capgun gem.
+
+1. account
+1. estimate
+1. capture
+1. status
+1. order
+
+## account
+
+Fetches the account owner's information.
+
+```ruby
+# returns a Capgun::Account object
+account = Capgun.account
+# attributes: id, :name, :balance
+account.balance
+```
+
+example JSON responses from the capgun service.
+
+```shell
+curl -H 'Authorization: abc123' 'https://api.capgun.io/v1/account'
+```
+
+```json
+{
+  "account": {
+    "id": "vexuq9ff",
+    "name": "Acme Co.",
+    "notify": "http://example.com/notify",
+    "balance": 200,
+    "created_at": "2012-06-08T05:55:39+00:00",
+    "updated_at": "2012-06-08T05:55:39+00:00"
+  }
+}
+```
+
+
+## estimate
+
+An estimate is an order that has not been executed.  It lists the assets that
+will be delivered in the order and its cost.
+
+```ruby
+# returns a Capgun::Order object
+estimate = Capgun.estimate("http://www.google.com/")
+# attributes: url, notify, cost, viewport, packages, images, options
+estimate.cost
+```
+
+example JSON responses from the capgun service.
+
+```shell
+curl -H 'Authorization: abc123' \
+     --data '{"url":"http://rubygems.org/"}'  \
+     'https://api.capgun.io/v1/orders/estimate.json'
+```
+
+```json
+{
+  "order": {
+    "url": "http://rubygems.org/",
+    "notify": null,
+    "cost": 1,
+    "viewport": "1024x768",
+    "images": {
+      "xlarge": "640x480"
+    },
+    "packages": [
+      "base"
+    ],
+    "options": [
+      {
+        "package": "base"
+      },
+      {
+        "url": "http://rubygems.org/"
+      },
+      {
+        "notify": null
+      },
+      {
+        "timeout": 5000
+      },
+      {
+        "viewport": "1024x768"
+      },
+      {
+        "image": {
+          "xlarge": "640x480"
+        }
+      }
+    ]
+  }
+}
+```
+
+
+## capture
+
+Capture executes an order.  The order object lists the assets that will be
+delivered in the order, the order's cost, and the job representing the order.
+
+```ruby
+# returns a Capgun::Order object
+order = Capgun.capture("http://www.google.com/")
+# attributes: id, url, notify, cost, viewport, packages, images, asset_urls, options, job
+order.viewport
+```
+
+example JSON responses from the capgun service.
+
+```shell
+curl -H 'Authorization: abc123' \
+     --data '{"url":"http://rubygems.org/"}'  \
+     'https://api.capgun.io/v1/orders.json'
+```
+
+```json
+{
+  "order": {
+    "created_at": "2013-04-17T20:23:29-07:00",
+    "url": "http://rubygems.org/",
+    "notify": null,
+    "cost": 1,
+    "viewport": "1024x768",
+    "images": {
+      "xlarge": "640x480"
+    },
+    "packages": [
+      "base"
+    ],
+    "id": "u1qj2mz1",
+    "options": [
+      {
+        "package": "base"
+      },
+      {
+        "url": "http://rubygems.org/"
+      },
+      {
+        "notify": null
+      },
+      {
+        "timeout": 5000
+      },
+      {
+        "viewport": "1024x768"
+      },
+      {
+        "image": {
+          "xlarge": "640x480"
+        }
+      }
+    ],
+    "job": {
+      "state": "initialized",
+      "transition": "capturing",
+      "id": "qy9ujcly"
+    }
+  }
+}
+```
+
+
+## status
+
+Status is a lighter call to get the status of an order.
+
+```ruby
+# returns a Capgun::Job object
+job = Capgun.status("qy9ujcly")
+# attributes: id, state, order_id
+job.state
+```
+
+example JSON responses from the capgun service.
+
+```shell
+curl -H 'Authorization: abc123' 'https://api.capgun.io/v1/jobs/qy9ujcly'
+```
+
+```json
+{
+  "job": {
+    "state": "initialized",
+    "transition": "capturing",
+    "created_at": "2013-04-17T20:23:29-07:00",
+    "id": "qy9ujcly",
+    "order_id": "u1qj2mz1"
+  }
+}
+```
+
+
+## order
+
+Fetches an existing order object and lists the assets that it delivers in the
+order, the order's cost, and the job representing the order.
+
+```ruby
+# returns a Capgun::Order object
+order = Capgun.order("u9qj2mc9")
+# attributes: url, notify, cost, viewport, packages, images, options
+order.asset_urls
+order.asset_urls["xlarge"]
+order.asset_urls["package"]
+```
+
+example JSON responses from the capgun service.
+
+```shell
+curl -H 'Authorization: abc123' 'https://api.capgun.io/v1/orders/u9qj2mc9'
+```
+
+```json
+{
+  "order": {
+    "created_at": "2013-02-17T22:45:20-08:00",
+    "url": "http://rubygems.org/",
+    "notify": null,
+    "cost": 1,
+    "viewport": "1024x768",
+    "images": {
+      "xlarge": "640x480"
+    },
+    "asset_urls": {
+      "xlarge": "https://api.capgun.io/v1/orders/u9qj2mc9/640x480.png",
+      "package": "https://api.capgun.io/v1/orders/u9qj2mc9/package.zip"
+    },
+    "packages": [
+      "base"
+    ],
+    "id": "u9qj2mc9",
+    "options": [
+      {
+        "package": "base"
+      },
+      {
+        "url": "http://rubygems.org/"
+      },
+      {
+        "notify": null
+      },
+      {
+        "timeout": 5000
+      },
+      {
+        "viewport": "1024x768"
+      },
+      {
+        "image": {
+          "xlarge": "640x480"
+        }
+      }
+    ],
+    "job": {
+      "state": "completed",
+      "transition": "complete",
+      "queued": 1.2787141799926758,
+      "capturing": 25.210319995880127,
+      "processing": 4.529249906539917,
+      "duration": 31.01828408241272,
+      "id": "5dlj5i1u"
+    }
+  }
+}
+```

data/Rakefile

@@ -1,3 +1,11 @@
-require 'rubygems'
-require 'bundler/setup'
+require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/capgun.gemspec

@@ -1,23 +1,34 @@
 $:.unshift File.expand_path("../lib", __FILE__)
 require "capgun/version"
 
-Gem::Specification.new do |s|
-  s.name          = "capgun"
-  s.version       = Capgun::VERSION::STRING
-  s.platform      = Gem::Platform::RUBY
-  s.authors       = ["Mike Mondragon"]
-  s.email         = ["mikemondragon@gmail.com"]
-  s.homepage      = "http://capgun.io/"
-  s.summary       = "Ruby API to capgun.io web thumb service"
-  s.description   = "Ruby API to capgun.io web thumb service"
+Gem::Specification.new do |gem|
 
-  s.rubyforge_project = "capgun"
-  s.rubygems_version = ">= 1.3.6"
+  gem.add_dependency 'activesupport', ['>= 2.3.9', '< 4']
+  gem.add_dependency 'faraday', '~> 0.8'
+  gem.add_dependency 'json', '~> 1.6.6'
+  gem.add_dependency 'multi_json', '~> 1.3'
 
-  s.add_development_dependency "rspect"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'yard'
 
-  s.files         = `git ls-files`.split("\n")
-  s.executables   = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
-  s.require_path  = 'lib'
-end
+  gem.name          = "capgun"
+  gem.version       = Capgun::Version.to_s
+  gem.platform      = Gem::Platform::RUBY
+  gem.authors       = ["Mike Mondragon"]
+  gem.email         = ["mikemondragon@gmail.com"]
+  gem.homepage      = "http://capgun.io/"
+  gem.summary       = "capgun.io API wrapper"
+  gem.description   = "Ruby wrapper for the capgun.io web thumb service API"
+
+  gem.rubyforge_project = "capgun"
+  gem.rubygems_version = ">= 1.3.6"
 
+  gem.files         = `git ls-files`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  gem.require_path  = 'lib'
+
+  gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+end