carve 0.0.1 → 0.0.2

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.env
+.env*

data/README.md

@@ -38,8 +38,21 @@ Replace the url with a url of the PDF or Microsoft Word file you choose.
 
     $ Carve::Document.pages("id_of_document")
 
+### List Events
+
+```bash
+$ Carve::Event.all
+$ Carve::Event.all(:type => "document.done", :count => 100)
+```
+
 ## Contributing
 
+0. Add your application configuration to your .env file in the root of this project
+
+```bash
+$ echo "CARVE_SECRET_API_KEY=yourkey" > .env
+```
+
 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"

data/carve.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   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.homepage      = "http://github.com/scottmotte/carve-ruby"
 
   gem.add_dependency "faraday"
   gem.add_dependency "faraday_middleware"
@@ -19,6 +19,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "pry"
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec"
+  gem.add_development_dependency "dotenv"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/carve.rb

@@ -3,6 +3,7 @@ require "faraday_middleware"
 require "recursive-open-struct"
 require "carve/version"
 require "carve/document"
+require "carve/event"
 
 module Carve
   extend self

data/lib/carve/event.rb

@@ -0,0 +1,18 @@
+module Carve
+  class Event
+    # 
+    # Api calls
+    # 
+    def self.all(options={})
+      url = ["events.json?"]
+      url << "type=#{options[:type]}"     if options[:type]
+      url << "count=#{options[:count]}"   if options[:count]
+      url << "offset=#{options[:offset]}" if options[:offset]
+
+      url = url.join("&")
+
+      response = Carve.request.get url 
+      RecursiveOpenStruct.new(response.body, :recurse_over_arrays => true)
+    end
+  end
+end

data/lib/carve/version.rb

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

data/spec/carve/document_spec.rb

@@ -116,4 +116,4 @@ describe Carve::Document do
       end
     end
   end
-end
+end

data/spec/carve/event_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Carve::Event do
+  let(:subject)   { Carve::Event }
+
+  context "incorrect secret api key" do
+    before do
+      Carve.secret_api_key = "incorrect_secret_api_key"
+    end
+
+    describe "attempt .all" do
+      before do
+        @response = subject.all
+      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 ".all" do
+      before do
+        @response = subject.all(attrs)
+      end
+
+      context "default" do
+        let(:attrs) { {} }
+
+        it do
+          @response.success.should be_true
+          @response.events.count.should eq 10
+        end
+      end
+
+      context "filters" do
+        let(:attrs) { {count: 20, type: "document.done"} }
+
+        it do
+          @response.success.should be_true
+          @response.events.count.should eq 20
+        end
+      end
+    end
+  end
+end

data/spec/carve/version_spec.rb

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

data/spec/spec_helper.rb

@@ -2,6 +2,8 @@ require 'rubygems'
 require 'bundler/setup'
 require 'pry'
 require 'carve'
+require 'dotenv'
+Dotenv.load
 
 Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
 
@@ -17,4 +19,4 @@ end
 
 def set_secret_and_public_api_keys!
   Carve.secret_api_key = ENV['CARVE_SECRET_API_KEY']
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carve
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-29 00:00:00.000000000 Z
+date: 2013-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &16773280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,15 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *16773280
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &16772380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -37,15 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *16772380
 - !ruby/object:Gem::Dependency
   name: recursive-open-struct
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &16771960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -53,15 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *16771960
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &16771500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -69,15 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *16771500
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &16787420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -85,15 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *16787420
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &16787000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -101,12 +76,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  version_requirements: *16787000
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: &16786540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16786540
 description: Ruby bindings for the Carve.io API.
 email:
 - scott@scottmotte.com
@@ -123,12 +104,14 @@ files:
 - carve.gemspec
 - lib/carve.rb
 - lib/carve/document.rb
+- lib/carve/event.rb
 - lib/carve/version.rb
 - spec/carve/document_spec.rb
+- spec/carve/event_spec.rb
 - spec/carve/version_spec.rb
 - spec/carve_spec.rb
 - spec/spec_helper.rb
-homepage: http://carve.io/api
+homepage: http://github.com/scottmotte/carve-ruby
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -140,20 +123,27 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 4310452240879777070
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 4310452240879777070
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Convert documents or webpages to PDF and PNGs
 test_files:
 - spec/carve/document_spec.rb
+- spec/carve/event_spec.rb
 - spec/carve/version_spec.rb
 - spec/carve_spec.rb
 - spec/spec_helper.rb