capgun 0.0.1 → 0.0.3

data/lib/capgun/error/forbidden.rb

@@ -0,0 +1,7 @@
+require 'capgun/error/client_error'
+
+module Capgun
+  # Raised when Capgun returns the HTTP status code 403
+  class Error::Forbidden < Capgun::Error::ClientError
+  end
+end

data/lib/capgun/error/internal_server_error.rb

@@ -0,0 +1,7 @@
+require 'capgun/error/server_error'
+
+module Capgun
+  # Raised when Capgun returns the HTTP status code 500
+  class Error::InternalServerError < Capgun::Error::ServerError
+  end
+end

data/lib/capgun/error/not_acceptable.rb

@@ -0,0 +1,7 @@
+require 'capgun/error/client_error'
+
+module Capgun
+  # Raised when Capgun returns the HTTP status code 406
+  class Error::NotAcceptable < Capgun::Error::ClientError
+  end
+end

data/lib/capgun/error/not_found.rb

@@ -0,0 +1,7 @@
+require 'capgun/error/client_error'
+
+module Capgun
+  # Raised when Capgun returns the HTTP status code 404
+  class Error::NotFound < Capgun::Error::ClientError
+  end
+end

data/lib/capgun/error/server_error.rb

@@ -0,0 +1,7 @@
+require 'capgun/error'
+
+module Capgun
+  # Raised when Capgun returns a 5xx HTTP status code
+  class Error::ServerError < Capgun::Error
+  end
+end

data/lib/capgun/error/service_unavailable.rb

@@ -0,0 +1,7 @@
+require 'capgun/error/server_error'
+
+module Capgun
+  # Raised when Capgun returns the HTTP status code 503
+  class Error::ServiceUnavailable < Capgun::Error::ServerError
+  end
+end

data/lib/capgun/error/unauthorized.rb

@@ -0,0 +1,7 @@
+require 'capgun/error/client_error'
+
+module Capgun
+  # Raised when Capgun returns the HTTP status code 401
+  class Error::Unauthorized < Capgun::Error::ClientError
+  end
+end

data/lib/capgun/estimate.rb

@@ -0,0 +1,11 @@
+module Capgun
+
+  # capgun capture estimate
+
+  class Estimate < Capgun::Base
+
+    lazy_attr_reader :url, :notify, :cost, :viewport, :packages, :images, :options
+
+  end
+
+end

data/lib/capgun/job.rb

@@ -0,0 +1,13 @@
+module Capgun
+
+  # capgun job
+
+  class Job < Capgun::Base
+
+    include Capgun::Creatable
+
+    lazy_attr_reader :id, :state, :order_id
+
+  end
+
+end

data/lib/capgun/order.rb

@@ -0,0 +1,13 @@
+module Capgun
+
+  # capgun capture order
+
+  class Order < Capgun::Base
+
+    include Capgun::Creatable
+
+    lazy_attr_reader :id, :url, :notify, :cost, :viewport, :packages, :images, :asset_urls, :options, :job
+
+  end
+
+end

data/lib/capgun/request.rb

@@ -0,0 +1,33 @@
+module Capgun
+  # Defines HTTP request methods
+  module Request
+
+    # Perform an HTTP GET request
+    def get(path, params={}, options={})
+      request(:get, path, params, options)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, params={}, options={})
+      request(:post, path, params, options)
+    end
+
+  private
+
+    # Perform an HTTP request
+    def request(method, path, params, options)
+      response = connection(options).run_request(method, nil, nil, nil) do |request|
+        request.options[:raw] = true if options[:raw]
+        case method.to_sym
+        when :get
+          request.url(path, params)
+        when :post
+          request.path = path
+          request.body = params.to_json unless params.empty?
+        end
+      end
+      options[:raw] ? response : response.body
+    end
+
+  end
+end

data/lib/capgun/request/gateway.rb

@@ -0,0 +1,20 @@
+require 'faraday'
+
+module Capgun
+  module Request
+    class Gateway < Faraday::Middleware
+
+      def call(env)
+        url = env[:url].dup
+        url.host = @gateway
+        env[:url] = url
+        @app.call(env)
+      end
+
+      def initialize(app, gateway)
+        @app, @gateway = app, gateway
+      end
+
+    end
+  end
+end

data/lib/capgun/response/parse_json.rb

@@ -0,0 +1,28 @@
+require 'faraday'
+require 'multi_json'
+
+module Capgun
+  module Response
+    class ParseJson < Faraday::Response::Middleware
+
+      def parse(body)
+          case body
+          when ''
+            nil
+          when 'true'
+            true
+          when 'false'
+            false
+          else
+            MultiJson.load(body)
+          end
+      end
+
+      def on_complete(env)
+        if respond_to? :parse
+          env[:body] = parse(env[:body]) unless env[:request][:raw] or [204,304].index env[:status]
+        end
+      end
+    end
+  end
+end

data/lib/capgun/response/raise_client_error.rb

@@ -0,0 +1,48 @@
+require 'faraday'
+require 'capgun/error/bad_request'
+require 'capgun/error/forbidden'
+require 'capgun/error/not_acceptable'
+require 'capgun/error/not_found'
+require 'capgun/error/unauthorized'
+
+module Capgun
+  module Response
+    class RaiseClientError < Faraday::Response::Middleware
+
+      def on_complete(env)
+        case env[:status].to_i
+        when 400
+          raise Capgun::Error::BadRequest.new(error_body(env[:body]), env[:response_headers])
+        when 401
+          raise Capgun::Error::Unauthorized.new(error_body(env[:body]), env[:response_headers])
+        when 403
+          raise Capgun::Error::Forbidden.new(error_body(env[:body]), env[:response_headers])
+        when 404
+          raise Capgun::Error::NotFound.new(error_body(env[:body]), env[:response_headers])
+        when 406
+          raise Capgun::Error::NotAcceptable.new(error_body(env[:body]), env[:response_headers])
+        end
+      end
+
+    private
+
+      def error_body(body)
+        if body.nil?
+          ''
+        elsif body['message']
+          body['message']
+        elsif body['error']
+          body['error']
+        elsif body['errors']
+          first = Array(body['errors']).first
+          if first.kind_of?(Hash)
+            first['message'].chomp
+          else
+            first.chomp
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/capgun/response/raise_server_error.rb

@@ -0,0 +1,23 @@
+require 'faraday'
+require 'capgun/error/bad_gateway'
+require 'capgun/error/internal_server_error'
+require 'capgun/error/service_unavailable'
+
+module Capgun
+  module Response
+    class RaiseServerError < Faraday::Response::Middleware
+
+      def on_complete(env)
+        case env[:status].to_i
+        when 500
+          raise Capgun::Error::InternalServerError.new("Something is technically wrong.", env[:response_headers])
+        when 502
+          raise Capgun::Error::BadGateway.new("Capgun is down!", env[:response_headers])
+        when 503
+          raise Capgun::Error::ServiceUnavailable.new("(__-){ Capgun is over capacity.", env[:response_headers])
+        end
+      end
+
+    end
+  end
+end

data/lib/capgun/version.rb

@@ -1,10 +1,30 @@
-module Capgun #:nodoc:
-  module VERSION #:nodoc:
-    MAJOR = 0
-    MINOR = 0
-    TINY  = 1
+module Capgun
+  class Version
+
+    # @return [Integer]
+    def self.major
+      0
+    end
+
+    # @return [Integer]
+    def self.minor
+      0
+    end
+
+    # @return [Integer]
+    def self.patch
+      3
+    end
+
+    # @return [String, NilClass]
+    def self.pre
+      nil
+    end
+
+    # @return [String]
+    def self.to_s
+      [major, minor, patch, pre].compact.join('.')
+    end
 
-    STRING = [MAJOR, MINOR, TINY].join('.')
   end
 end
-

data/spec/capgun/account_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Capgun::Account do
+
+  describe "#==" do
+    it "should return true when ids and classes are equal" do
+      user = Capgun::Account.new('id' => 1)
+      other = Capgun::Account.new('id' => 1)
+      (user == other).should be_true
+    end
+    it "should return false when classes are not equal" do
+      user = Capgun::Account.new('id' => 1)
+      other = Capgun::Order.new('id' => 1)
+      (user == other).should be_false
+    end
+    it "should return false when ids are not equal" do
+      user = Capgun::Account.new('id' => 1)
+      other = Capgun::Job.new('id' => 2)
+      (user == other).should be_false
+    end
+  end
+
+  describe "#created_at" do
+    it "should return a Time when created_at is set" do
+      user = Capgun::Account.new('created_at' => "Mon Jul 16 12:59:01 +0000 2007")
+      user.created_at.should be_a Time
+    end
+    it "should return nil when created_at is not set" do
+      user = Capgun::Account.new
+      user.created_at.should be_nil
+    end
+  end
+
+  describe "#updated_at" do
+    it "should return a Time when updated_at is set" do
+      user = Capgun::Account.new('updated_at' => "Mon Jul 16 12:59:01 +0000 2007")
+      user.updated_at.should be_a Time
+    end
+    it "should return nil when updated_at is not set" do
+      user = Capgun::Account.new
+      user.updated_at.should be_nil
+    end
+  end
+
+end

data/spec/capgun/base_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Capgun::Base do
+
+  before do
+    @base = Capgun::Base.new('id' => 1)
+  end
+
+  describe "#[]" do
+    it "should be able to call methods using [] with symbol" do
+      @base[:object_id].should be_an Integer
+    end
+    it "should be able to call methods using [] with string" do
+      @base['object_id'].should be_an Integer
+    end
+    it "should return nil for missing method" do
+      @base[:foo].should be_nil
+      @base['foo'].should be_nil
+    end
+  end
+
+  describe "#to_hash" do
+    it "should return a hash" do
+      @base.to_hash.should be_a Hash
+      @base.to_hash['id'].should == 1
+    end
+  end
+
+end

data/spec/capgun/client_spec.rb

@@ -0,0 +1,181 @@
+require 'spec_helper'
+
+describe Capgun::Client do
+
+  before do
+    @keys = Capgun::Config::VALID_OPTIONS_KEYS
+  end
+
+  context "invalid client" do
+
+    specify "not allowed to get estimates without authorization" do
+      stub_request(:post, "https://api.capgun.io/v1/orders/estimate.json").
+        with(:body => "{\"url\":\"http://example.com/test\"}",
+             :headers => {'Accept'=>'application/json', 'Authorization'=>'', 'User-Agent'=>'Capgun.io Ruby Gem 0.0.3'}).
+        to_return(:status => 401, :body => fixture("unauthorized.json"), :headers => {})
+
+      lambda { Capgun.estimate("http://example.com/test") }.should raise_error(Capgun::Error::Unauthorized, "Unauthorized")
+    end
+
+    specify "no urls are submitted for capture" do
+      stub_request(:post, "https://api.capgun.io/v1/orders.json").
+        with(:body => "{\"url\":\"http://example.com/test\"}",
+             :headers => {'Accept'=>'application/json', 'Authorization'=>'', 'User-Agent'=>'Capgun.io Ruby Gem 0.0.3'}).
+        to_return(:status => 401, :body => fixture("unauthorized.json"), :headers => {})
+
+      lambda { Capgun.capture("http://example.com/test") }.should raise_error(Capgun::Error::Unauthorized, "Unauthorized")
+    end
+
+    specify "not allowed to view on order without authorization" 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'=>'', 'User-Agent'=>'Capgun.io Ruby Gem 0.0.3'}).
+        to_return(:status => 401, :body => fixture("unauthorized.json"), :headers => {})
+
+      lambda { Capgun.order("4fd20a1288f560177600000a") }.should raise_error(Capgun::Error::Unauthorized, "Unauthorized")
+    end
+
+    specify "not allowed to view job status without authorization" do
+      stub_request(:get, "https://api.capgun.io/v1/jobs/4fd20a1288f5601776000012.json").
+        with(:headers => {'Accept'=>'application/json', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Authorization'=>'', 'User-Agent'=>'Capgun.io Ruby Gem 0.0.3'}).
+        to_return(:status => 401, :body => fixture('unauthorized.json'), :headers => {})
+
+      lambda { Capgun.status("4fd20a1288f5601776000012") }.should raise_error(Capgun::Error::Unauthorized, "Unauthorized")
+    end
+
+    specify "not allowed to view account" do
+      stub_request(:get, "https://api.capgun.io/v1/account.json").
+        with(:headers => {'Accept'=>'application/json', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Authorization'=>'', 'User-Agent'=>'Capgun.io Ruby Gem 0.0.3'}).
+        to_return(:status => 401, :body => fixture('unauthorized.json'), :headers => {})
+
+      lambda { Capgun.account }.should raise_error(Capgun::Error::Unauthorized, "Unauthorized")
+    end
+
+  end
+
+  context "client with capture credits" do
+
+    before do
+      Capgun.configure do |config|
+        config.auth_token = 'test'
+      end
+    end
+
+    after do
+      Capgun.reset
+    end
+
+    specify "get an estimate to capture a url" do
+      stub_request(:post, "https://api.capgun.io/v1/orders/estimate.json").
+        with(:body => "{\"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.json"), :headers => {})
+
+      estimate = Capgun.estimate("http://example.com/test")
+      estimate.cost.should == 1
+    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\"}",
+             :headers => {'Accept'=>'application/json', 'Authorization'=>'test', 'User-Agent'=>'Capgun.io Ruby Gem 0.0.3'}).
+        to_return(:status => 200, :body => fixture("order.json"), :headers => {})
+
+      order = Capgun.capture("http://example.com/test")
+      order.id.should == '4fd20a1288f560177600000a'
+      order.cost.should == 1
+    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'}).
+        to_return(:status => 200, :body => fixture("order.json"), :headers => {})
+
+      order = Capgun.order("4fd20a1288f560177600000a")
+      order.id.should == '4fd20a1288f560177600000a'
+      order.cost.should == 1
+    end
+
+    specify "capture jobs have a status" do
+      stub_request(:get, "https://api.capgun.io/v1/jobs/4fd20a1288f5601776000012.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'}).
+        to_return(:status => 200, :body => fixture('job.json'), :headers => {})
+
+
+      job = Capgun.status("4fd20a1288f5601776000012")
+      job.id.should == '4fd20a1288f5601776000012'
+      job.state.should == 'initialized'
+    end
+
+    specify "account can be retrieved" do
+      stub_request(:get, "https://api.capgun.io/v1/account.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'}).
+        to_return(:status => 200, :body => fixture('account.json'), :headers => {})
+
+      account = Capgun.account
+      account.id.should == '4fd193db88f5600472000001'
+      account.name.should == 'Acme Co.'
+      account.balance.should == 200
+    end
+
+  end
+
+  context "with module configuration" do
+
+    before do
+      Capgun.configure do |config|
+        @keys.each do |key|
+          config.send("#{key}=", key)
+        end
+      end
+    end
+
+    after do
+      Capgun.reset
+    end
+
+    specify "should inherit module configuration" do
+      api = Capgun::Client.new
+      @keys.each do |key|
+        api.send(key).should == key
+      end
+    end
+
+    context "with class configuration" do
+
+      before do
+        @configuration = {
+          :adapter => :net_http,
+          :connection_options => nil,
+          :endpoint => 'http://example.com/',
+          :gateway => nil,
+          :auth_token => 'AT',
+          :user_agent => 'Custom User Agent',
+          :proxy => nil,
+        }
+      end
+
+      context "during initialization" do
+        it "should override module configuration" do
+          api = Capgun::Client.new(@configuration)
+          @keys.each do |key|
+            api.send(key).should == @configuration[key]
+          end
+        end
+      end
+
+      context "after initilization" do
+        it "should override module configuration after initialization" do
+          api = Capgun::Client.new
+          @configuration.each do |key, value|
+            api.send("#{key}=", value)
+          end
+          @keys.each do |key|
+            api.send(key).should == @configuration[key]
+          end
+        end
+      end
+
+    end
+  end
+
+end