carve 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in carve.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 scottmotte
+
+MIT License
+
+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

@@ -0,0 +1,48 @@
+# Carve.io Ruby Bindings
+
+This gem is a wrapper for [Carve.io](http://carve.io)'s API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'carve'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install carve
+
+Then in your application initialize the gem:
+
+    $ Carve.secret_api_key = "your_secret_api_key"
+
+Alternatively, you can simply set the environment variables CARVE_SECRET_API_KEY on your machine. The rubygem will read it automatically so that you can skip the initialization.
+
+## Usage
+
+### Create Document
+
+    $ Carve::Document.create(:url => "https://www.signature.io/pdfs/sign-below.pdf")
+
+Replace the url with a url of the PDF or Microsoft Word file you choose.
+
+### Retrieve Document
+
+    $ Carve::Document.retrieve("id_of_document")
+
+### Retrieve Document Pages
+
+    $ Carve::Document.pages("id_of_document")
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. export CARVE_SECRET_API_KEY="your_test_secret_api_key"
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/carve.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'carve/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "carve"
+  gem.version       = Carve::VERSION
+  gem.authors       = ["scottmotte"]
+  gem.email         = ["scott@scottmotte.com"]
+  gem.description   = %q{Ruby bindings for the Carve.io API.}
+  gem.summary       = %q{Convert documents or webpages to PDF and PNGs}
+  gem.homepage      = "http://carve.io/api"
+
+  gem.add_dependency "faraday"
+  gem.add_dependency "faraday_middleware"
+  gem.add_dependency "recursive-open-struct"
+  
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/carve/document.rb

@@ -0,0 +1,21 @@
+module Carve
+  class Document
+    # 
+    # Api calls
+    # 
+    def self.create(attrs={})
+      response = Carve.request.post "documents.json", attrs
+      RecursiveOpenStruct.new(response.body, :recurse_over_arrays => true)
+    end
+
+    def self.retrieve(id=nil)
+      response = Carve.request.get "documents/#{id}.json"
+      RecursiveOpenStruct.new(response.body, :recurse_over_arrays => true)
+    end
+
+    def self.pages(id=nil)
+      response = Carve.request.get "documents/#{id}/pages.json"
+      RecursiveOpenStruct.new(response.body, :recurse_over_arrays => true)
+    end
+  end
+end

data/lib/carve/version.rb

@@ -0,0 +1,3 @@
+module Carve
+  VERSION = "0.0.1"
+end

data/lib/carve.rb

@@ -0,0 +1,74 @@
+require "faraday"
+require "faraday_middleware"
+require "recursive-open-struct"
+require "carve/version"
+require "carve/document"
+
+module Carve
+  extend self
+
+  def request=(request)
+    @request = request
+  end
+
+  def request
+    @request || setup_request!
+  end
+
+  def secret_api_key=(secret_api_key)
+    @secret_api_key = secret_api_key
+    setup_request!
+
+    @secret_api_key
+  end
+
+  def secret_api_key
+    return @secret_api_key if @secret_api_key
+    ENV['CARVE_SECRET_API_KEY'] || "missing_secret_api_key"
+  end
+
+  def api_version=(api_version)
+    @api_version = api_version
+    setup_request!
+
+    @api_version
+  end
+
+  def api_version
+    return @api_version if @api_version
+    0
+  end
+
+  def _root_url=(_root_url)
+    @_root_url = _root_url
+  end
+
+  def _root_url
+    return @_root_url if @_root_url
+    "https://carve.herokuapp.com"
+  end
+
+  def api_endpoint
+    [_root_url, "/api/v", api_version].join
+  end
+
+  private
+
+  def setup_request!
+    options = {
+      headers:  {'Accept' => "application/json"},
+      ssl:      {:verify => false},
+      url:      Carve.api_endpoint
+    }
+
+    Carve.request = ::Faraday::Connection.new(options) do |builder|
+      builder.use     ::Faraday::Request::UrlEncoded
+      builder.use     ::FaradayMiddleware::ParseJson
+      builder.adapter ::Faraday.default_adapter
+    end
+
+    Carve.request.basic_auth(Carve.secret_api_key, '')
+
+    Carve.request
+  end
+end

data/spec/carve/document_spec.rb

@@ -0,0 +1,119 @@
+require 'spec_helper'
+
+describe Carve::Document do
+  let(:subject)   { Carve::Document }
+  let(:url)       { "https://www.signature.io/pdfs/sign-below.pdf" }
+
+  context "incorrect secret api key" do
+    before do
+      Carve.secret_api_key = "incorrect_secret_api_key"
+    end
+
+    describe "attempt .create" do
+      before do
+        @response = subject.create({:url => url})
+      end
+
+      it do
+        @response.success.should be_false
+        @response.error.message.should_not be_empty
+      end
+    end
+
+    describe "attempt .retrieve" do
+      before do
+        @response = subject.retrieve("1234")
+      end
+
+      it do
+        @response.success.should be_false
+        @response.error.message.should_not be_empty
+      end
+    end
+  end
+
+  context "correct secret api key" do
+    before do
+      Carve.secret_api_key = ENV['CARVE_SECRET_API_KEY']
+    end
+
+    describe ".create" do
+      before do
+        @response = subject.create(attrs)
+      end
+
+      context "default" do
+        let(:attrs) { {:url => url} }
+
+        it do
+          @response.success.should be_true
+          @response.document.id.should_not be_empty
+        end
+      end
+
+      context "blank url" do
+        let(:attrs) { {:url => nil} }
+
+        it do 
+          @response.success.should be_false
+          @response.error.message.should_not be_empty
+        end
+      end
+
+      context "invalid url" do
+        let(:attrs) { {:url => "noexisturl"} }
+
+        it do 
+          @response.success.should be_false
+          @response.error.message.should_not be_empty
+        end
+      end
+    end
+
+    describe ".retrieve" do
+      before do
+        response = subject.create({:url => url})
+        @id = response.document.id
+      end
+
+      context "default" do
+        before do
+          @response = subject.retrieve(@id)
+        end
+        
+        it do
+          @response.success.should be_true
+          @response.document.id.should eq @id
+        end
+      end
+
+      context "incorrect id" do
+        before do
+          @response = subject.retrieve("1234")
+        end
+
+        it do
+          @response.success.should be_false
+          @response.error.message.should_not be_empty
+        end
+      end
+    end
+
+    describe ".pages" do
+      before do
+        response = subject.create({:url => url})
+        @id = response.document.id
+        puts "sleep for 30"
+        sleep 30
+        @response = subject.pages(@id)
+      end
+
+      context "default" do
+        it do
+          @response.success.should be_true
+          @response.pages.count.should >= 1
+        end
+      end
+    end
+  end
+end

data/spec/carve/version_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Carve do
+  it { Carve::VERSION.should eq "0.0.1" }
+end

data/spec/carve_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Carve do
+  subject { Carve }
+
+  describe "defaults" do
+    before do
+      subject.secret_api_key  = nil
+      subject.api_version     = nil
+    end
+
+    it { subject.api_endpoint.should eq "https://carve.herokuapp.com/api/v0" }
+    it { subject.api_version.should eq 0 }
+  end
+
+  describe "setting values" do
+    let(:secret_api_key)  { "sk_1234" }
+    let(:api_version)     { 1 }
+
+    before do
+      subject.secret_api_key  = secret_api_key
+      subject.api_version     = api_version
+    end
+
+    it { subject.api_version.should eq api_version }
+    it { subject.secret_api_key.should eq secret_api_key }
+    it { subject.api_endpoint.should eq "https://carve.herokuapp.com/api/v1" }
+  end
+
+  describe "setting _root_url" do
+    let(:api_version)     { 0 }
+
+    before do
+      subject.api_version   = api_version
+      subject._root_url     = "http://localhost:3000"
+    end
+
+    it { subject._root_url = "http://localhost:3000" }
+    it { subject.api_endpoint.should eq "http://localhost:3000/api/v0" }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'pry'
+require 'carve'
+
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    # FakeWeb.allow_net_connect = false
+  end
+
+  # config.after(:suite) do
+  #   FakeWeb.allow_net_connect = true
+  # end
+end
+
+def set_secret_and_public_api_keys!
+  Carve.secret_api_key = ENV['CARVE_SECRET_API_KEY']
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: carve
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- scottmotte
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: recursive-open-struct
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby bindings for the Carve.io API.
+email:
+- scott@scottmotte.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- carve.gemspec
+- lib/carve.rb
+- lib/carve/document.rb
+- lib/carve/version.rb
+- spec/carve/document_spec.rb
+- spec/carve/version_spec.rb
+- spec/carve_spec.rb
+- spec/spec_helper.rb
+homepage: http://carve.io/api
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Convert documents or webpages to PDF and PNGs
+test_files:
+- spec/carve/document_spec.rb
+- spec/carve/version_spec.rb
+- spec/carve_spec.rb
+- spec/spec_helper.rb