cubaru 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4734fd5a4afb64d4a2f8d16d3fa4439ed5ee2115
+  data.tar.gz: bbe25ff4ef35f71f04b741006ddd9f524381389c
+SHA512:
+  metadata.gz: 1177ce896ccdb36430900901d376df6fe368b3dc988145cfc215477094fc311f4786210431838239d6b2164df6391d13d1170cef89313e976d3909f1be29999f
+  data.tar.gz: 55b09b5a3e7859098ec1ba27e752677de9cb0444c786ade17240bc6fd42f9808e513d442cb593271e14705704b97fd15bbb2ae7ec19d473f5463d6f0a124ca99

data/.gitignore

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

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 hitoshi.tsuyuki
+
+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,29 @@
+# Cubaru::Ruby
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cubaru'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cubaru
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/cubaru.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cubaru/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cubaru"
+  spec.version       = Cubaru::VERSION
+  spec.authors       = ["hitoshi.tsuyuki"]
+  spec.email         = ["hitoshi.tsuyuki"]
+  spec.summary       = %q{Ruby bindings for the Cubaru API}
+  spec.description   = %q{Cubaru is the easiest way to print and mail.  See https://www.cubaru.com for details}
+  spec.homepage      = "https://www.cubaru.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency('rest-client', '~> 1.6')
+  spec.add_dependency('json', '~> 1.8.1')
+
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock", '~> 1.15.2'
+end

data/lib/cubaru.rb

@@ -0,0 +1,63 @@
+require 'rest-client'
+require 'json'
+
+require "cubaru/version"
+require 'cubaru/error'
+require 'cubaru/v1/resource'
+require "cubaru/v1/address/resource"
+require "cubaru/v1/postcard/resource"
+
+module Cubaru
+  class << self
+    attr_accessor :api_key,
+      :api_version,
+      :protocol,
+      :api_host
+
+    def configure
+      yield self
+      true
+    end
+
+		def require_options(options, *keys)
+			keys.each do |key|
+				raise ArgumentError.new(":#{key} is required") unless options.key?(key)
+			end
+		end
+
+		def submit(method, url, parameters={})
+			parameters = {:params => parameters} if method == :get
+			JSON(RestClient.send(method, url, parameters))
+		rescue => e
+			error_message = nil
+			raise e unless e.respond_to? :http_body
+			begin
+				json = JSON(e.http_body)
+
+				if json.has_key? 'errors'
+					error_message = json["errors"].first.values.first
+				elsif json.has_key? 'message'
+					error_message = json["message"]
+				else
+					error_message = "Unknown error: #{json}"
+				end
+			rescue => e
+				raise e
+			end
+			raise Cubaru::Error.new(error_message)
+		end
+	end
+end
+
+def Cubaru(options={})
+  options[:api_host]     ||= Cubaru.api_host    || "api.cubaru.com"
+  options[:protocol]     ||= Cubaru.protocol    || "https"
+  options[:api_version]  ||= Cubaru.api_version || "v1"
+  options[:api_key]      ||= Cubaru.api_key
+
+  unless options[:api_key]
+    raise ArgumentError.new(":api_key is a required argument to initialize Cubaru")
+  end
+
+  Cubaru.const_get("#{options[:api_version].capitalize}").const_get("Resource").new(options)
+end

data/lib/cubaru/error.rb

@@ -0,0 +1,4 @@
+module Cubaru
+  class Error < StandardError
+  end
+end

data/lib/cubaru/v1/address/resource.rb

@@ -0,0 +1,34 @@
+module Cubaru
+  module V1
+    module Address
+      class Resource
+
+        def initialize(resource)
+          @resource = resource
+        end
+
+        def list(options={})
+          Cubaru.submit(:get, address_url, options)["data"] || []
+        end
+
+        def find(address_id)
+          Cubaru.submit :get, address_url(address_id)
+        end
+
+        def create(options = {})
+          Cubaru.submit :post, address_url, @resource.format_address_params(options)
+        end
+
+        def destroy(address_id)
+          Cubaru.submit :delete, address_url(address_id)
+        end
+
+        private
+
+        def address_url(address_id = nil)
+          @resource.construct_url("addresses", address_id)
+        end
+      end
+    end
+  end
+end

data/lib/cubaru/v1/postcard/resource.rb

@@ -0,0 +1,39 @@
+module Cubaru
+  module V1
+    module Postcard
+      class Resource
+
+        def initialize(resource)
+          @resource = resource
+        end
+
+        def list(options={})
+          Cubaru.submit(:get, postcard_url, options)["data"] || []
+        end
+
+        def find(postcard_id)
+          Cubaru.submit :get, postcard_url(postcard_id)
+        end
+
+        def create(options = {})
+          if options[:to] && !options[:to].is_a?(String)
+            options[:to] = @resource.format_address_params(options[:to])
+          end
+
+          if options[:from] && !options[:from].is_a?(String)
+            options[:from] = @resource.format_address_params(options[:from])
+          end
+
+          Cubaru.submit :post, postcard_url, options
+        end
+
+        private
+
+        def postcard_url(postcard_id = nil)
+          @resource.construct_url("postcards", postcard_id)
+        end
+
+      end
+    end
+  end
+end

data/lib/cubaru/v1/resource.rb

@@ -0,0 +1,43 @@
+module Cubaru
+	module V1
+		class Resource
+
+			attr_accessor :options
+
+			def initialize(options)
+				@options = options
+			end
+
+			def addresses
+				Cubaru::V1::Address::Resource.new(self)
+			end
+
+			def postcards
+				Cubaru::V1::Postcard::Resource.new(self)
+			end
+
+			def base_url
+				"#{@options[:protocol]}://#{@options[:api_key]}:@#{@options[:api_host]}/v1"
+			end
+
+			def construct_url(resource_type, resource_id=nil)
+				"#{base_url}/#{resource_type}#{'/' + resource_id if resource_id}"
+			end
+
+      def format_address_params(params, check_required_options=true)
+        if check_required_options
+          Cubaru.require_options(params, :name, :address_line1, :city, :state, :zip, :country)
+        end
+
+        new_params = params.clone
+
+        [:city, :state, :zip, :country].each do |option|
+          new_params["address_#{option}".to_sym] = params[option] if params[option]
+          new_params.delete(option)
+        end
+
+        new_params
+      end
+		end
+  end
+end

data/lib/cubaru/version.rb

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

data/spec/cubaru/v1/address/resource_spec.rb

@@ -0,0 +1,71 @@
+require "spec_helper"
+
+describe Cubaru::V1::Address::Resource do
+  let(:sample_params2) {
+    {
+      name:    "Test1",
+      email:   "test@test.com",
+      address_line1: "テスト区テスト町１−２",
+      city:    "横浜市",
+      state:   "神奈川",
+      country: "JP",
+      zip:     "2220002"
+    }
+  }
+
+  let(:sample_params) {
+    {
+      name:    "Test",
+      email:   "test@test.com",
+      address_line1: "テスト町１−１",
+      city:    "港区",
+      state:   "東京都",
+      country: "JP",
+      zip:     "108-0000"
+    }
+  }
+
+  subject { Cubaru(api_key: ENV["CUBARU_API_KEY"], api_version: "v1") }
+
+  describe "list" do
+    it "should list addresses" do
+			VCR.use_cassette('list_addresses') do
+				new_address = subject.addresses.create sample_params
+				list_result = subject.addresses.list
+				expect(list_result.to_s).to match(/#{new_address["name"]}/)
+			end
+    end
+  end
+
+
+  describe "create" do
+    it "should create an address" do
+      VCR.use_cassette('create_address') do
+        result = subject.addresses.create sample_params
+				expect(sample_params[:name].to_s).to match(/#{result["name"]}/)
+      end
+    end
+  end
+
+
+  describe "find" do
+    it "should find an address" do
+      VCR.use_cassette('find_address') do
+        new_address = subject.addresses.create sample_params
+
+        find_result = subject.addresses.find(new_address["id"])
+				expect(find_result['name']).to match(/#{sample_params[:name]}/)
+      end
+    end
+  end
+
+
+  describe "destroy" do
+    it "should delete an address" do
+      VCR.use_cassette('delete_address') do
+        new_address = subject.addresses.create sample_params
+        expect { subject.addresses.destroy(new_address["id"]) }.not_to raise_error
+      end
+    end
+  end
+end

data/spec/cubaru/v1/postcard/resource_spec.rb

@@ -0,0 +1,129 @@
+require "spec_helper"
+
+describe Cubaru::V1::Postcard::Resource do
+
+  before :each do
+    @sample_address_params = {
+      name:    "Test1",
+      email:   "test@test.com",
+      address_line1: "テスト区テスト町１−２",
+      address_line2: "テストハイツ201",
+      city:    "横浜市",
+      state:   "神奈川",
+      country: "JP",
+      zip:     "2220002"
+    }
+
+    @sample_postcard_params    = {
+      name:    "TestPostcard",
+    }
+  end
+
+  subject { Cubaru(api_key: ENV["CUBARU_API_KEY"], api_version: "v1") }
+
+  describe "create" do
+    it "should create a postcard with address_id" do
+      VCR.use_cassette('create_postcard_with_address_id') do
+        new_address = subject.addresses.create @sample_address_params
+
+        result = subject.postcards.create(
+          name: @sample_postcard_params[:name],
+          to: new_address["id"],
+					from: @sample_address_params,
+          back: "https://www.cubaru.com/back.pdf"
+        )
+
+        expect(result["name"]).to eq(@sample_postcard_params[:name])
+      end
+    end
+
+
+    it "should create a postcard with address params" do
+      VCR.use_cassette('create_postcard_with_address_params') do
+
+        result = subject.postcards.create(
+          name: @sample_postcard_params[:name],
+          to: @sample_address_params,
+					from: @sample_address_params,
+          back: "https://www.cubaru.com/back.pdf"
+        )
+
+        expect(result["name"]).to eq(@sample_postcard_params[:name])
+      end
+    end
+
+
+    it "should create a postcard with front and back as urls" do
+      VCR.use_cassette('create_postcard_with_front_and_back_urls') do
+        new_address = subject.addresses.create @sample_address_params
+
+        result = subject.postcards.create(
+          name: @sample_postcard_params[:name],
+          to: new_address["id"],
+					from: @sample_address_params,
+          front: "https://www.cubaru.com/front.pdf",
+          back:  "https://www.cubaru.com/back.pdf"
+        )
+
+        expect(result["name"]).to eq(@sample_postcard_params[:name])
+      end
+    end
+
+		it "should create a postcard with front and back as PDFs" do
+			VCR.use_cassette('create_postcard_with_front_and_back_pdfs') do
+				new_address = subject.addresses.create @sample_address_params
+
+				result = subject.postcards.create(
+					name: @sample_postcard_params[:name],
+					to: new_address["id"],
+					from: @sample_address_params,
+          front: fixture_file('front.pdf'),
+          back: fixture_file('back.pdf')
+				)
+
+				expect(result["name"]).to eq @sample_postcard_params[:name]
+			end
+		end
+
+  end
+
+
+  describe "find" do
+    it "should find a postcard" do
+      VCR.use_cassette('find_postcard') do
+        new_address = subject.addresses.create @sample_address_params
+
+        new_postcard = subject.postcards.create(
+          name: @sample_postcard_params[:name],
+          to: new_address["id"],
+					from: @sample_address_params,
+          front: fixture_file('front.pdf'),
+          back: fixture_file('back.pdf')
+        )
+
+        result  = subject.postcards.find(new_postcard["id"])
+        expect(result["name"]).to eq(@sample_postcard_params[:name])
+      end
+    end
+  end
+
+  describe "list" do
+    it "should list postcards" do
+      VCR.use_cassette('list_postcards') do
+        new_address = subject.addresses.create @sample_address_params
+
+        new_postcard = subject.postcards.create(
+          name: @sample_postcard_params[:name],
+          to: new_address["id"],
+					from: @sample_address_params,
+          front: fixture_file('front.pdf'),
+          back: fixture_file('back.pdf')
+        )
+
+        list_result = subject.postcards.list
+	      expect(list_result.to_s).to match /#{new_postcard["name"]}/
+      end
+    end
+  end
+
+end

data/spec/cubaru/v1/resource_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+
+describe Cubaru::V1::Resource do
+
+	before :each do
+		@api_key = "test"
+	end
+
+	subject(:resource) { Cubaru(api_key: @api_key) }
+
+	describe "when Cubaru is initialized" do
+		it "should receive and contain default options when Cubaru is initialized" do
+			expect(resource.options[:protocol]).to eq "https"
+			expect(resource.options[:api_host]).to eq "api.cubaru.com"
+		end
+
+		it "should have API key in options" do
+			expect(resource.options[:api_key]).to eq @api_key
+		end
+	end
+
+	it "should return addresses resource" do
+		expect(resource.addresses).to be_kind_of(Cubaru::V1::Address::Resource)
+	end
+
+	it "should return postcards resource" do
+		expect(resource.postcards).to be_kind_of(Cubaru::V1::Postcard::Resource)
+	end
+
+end

data/spec/cubaru_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+module Cubaru
+	module Test
+		class Resource
+			attr_accessor :options
+			def initialize(options)
+				@options = options
+			end
+		end
+	end
+end
+
+describe Cubaru do
+	it "should return the resource object for the specified version" do
+		expect(Cubaru(api_key: "test", api_version: "test")).to be_kind_of(Cubaru::Test::Resource)
+	end
+
+	it "should raise an error if API key is not passed as an option or set on module" do
+		Cubaru.api_key = nil  # make sure API key is nil
+		expect{ Cubaru() }.to raise_error(ArgumentError)
+	end
+
+	it "should *not* raise an error if API key has been on module and not passed as option" do
+		Cubaru.api_key = "test"
+		expect(Cubaru()).not_to be_nil
+	end
+
+	it "should pass the API key to the resource for the version" do
+		expect(Cubaru(api_key: "test").options[:api_key]).to eq "test"
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+
+require "cubaru"
+require "vcr"
+
+VCR.configure do |config|
+	config.cassette_library_dir = "spec/cassettes"
+	config.hook_into :webmock
+end
+
+def fixture_file(filename)
+	File.new(File.expand_path("../fixtures/front.pdf", __FILE__))
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: cubaru
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- hitoshi.tsuyuki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.15.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.15.2
+description: Cubaru is the easiest way to print and mail.  See https://www.cubaru.com
+  for details
+email:
+- hitoshi.tsuyuki
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cubaru.gemspec
+- lib/cubaru.rb
+- lib/cubaru/error.rb
+- lib/cubaru/v1/address/resource.rb
+- lib/cubaru/v1/postcard/resource.rb
+- lib/cubaru/v1/resource.rb
+- lib/cubaru/version.rb
+- spec/cubaru/v1/address/resource_spec.rb
+- spec/cubaru/v1/postcard/resource_spec.rb
+- spec/cubaru/v1/resource_spec.rb
+- spec/cubaru_spec.rb
+- spec/fixtures/back.pdf
+- spec/fixtures/front.pdf
+- spec/spec_helper.rb
+homepage: https://www.cubaru.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for the Cubaru API
+test_files:
+- spec/cubaru/v1/address/resource_spec.rb
+- spec/cubaru/v1/postcard/resource_spec.rb
+- spec/cubaru/v1/resource_spec.rb
+- spec/cubaru_spec.rb
+- spec/fixtures/back.pdf
+- spec/fixtures/front.pdf
+- spec/spec_helper.rb
+has_rdoc: