crunch-api 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Aaron Chambers
+
+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,31 @@
+# Crunch::Api
+
+A Ruby interface to the Crunch Accounting API
+
+This is very early days.  Will be fleshing it out further soon
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'crunch-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install crunch-api
+
+## 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,12 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/crunch-api'
+  t.test_files = FileList['test/lib/**/*_test.rb']
+  t.ruby_opts = ['-r./test/test_helper.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/crunch-api.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'crunch-api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "crunch-api"
+  spec.version       = CrunchApi::VERSION
+  spec.authors       = ["Aaron Chambers"]
+  spec.email         = ["achambers@gmail.com"]
+  spec.description   = %q{A Ruby interface to the Crunch Accounting API}
+  spec.summary       = spec.description
+  spec.homepage      = ""
+  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("oauth", "~> 0.4.7")
+  spec.add_dependency("nori", "~> 2.2.0")
+  spec.add_dependency("nokogiri", "~> 1.5.9")
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "vcr", "~>2.4"
+end

data/lib/crunch-api/default.rb

@@ -0,0 +1,31 @@
+module CrunchApi
+  module Default
+    ENDPOINT = 'https://crunch.co.uk' unless defined? CrunchApi::Default::ENDPOINT
+
+    class << self
+      def options
+        Hash[CrunchApi.keys.map { |key| [key, send(key)] }]
+      end
+
+      def consumer_key
+        ENV['CRUNCH_CONSUMER_KEY']
+      end
+
+      def consumer_secret
+        ENV['CRUNCH_CONSUMER_SECRET']
+      end
+
+      def oauth_token
+        ENV['CRUNCH_OAUTH_TOKEN']
+      end
+
+      def oauth_token_secret
+        ENV['CRUNCH_OAUTH_TOKEN_SECRET']
+      end
+
+      def endpoint
+        ENDPOINT
+      end
+    end
+  end
+end

data/lib/crunch-api/supplier.rb

@@ -0,0 +1,47 @@
+require 'oauth'
+require 'nori'
+
+module CrunchApi
+  class Supplier
+
+    attr_reader :id, :uri, :name, :contact_name, :email, :website, :telephone, :fax, :default_expense_type
+
+    def initialize(xml)
+      @id = xml[:@supplierId]
+      @uri = xml[:@resourceUrl]
+      @default_expense_type = xml[:@defaultExpenseType]
+      @unknown_supplier_flag = xml[:@unknownSupplier] == "true"
+      @name = xml[:name]
+      @contact_name = xml[:contact_name]
+      @email = xml[:email]
+      @website = xml[:website]
+      @telephone = xml[:telephone]
+      @fax = xml[:fax]
+    end
+
+    def unknown_supplier?
+      @unknown_supplier_flag
+    end
+
+    def self.all
+      consumer = OAuth::Consumer.new(CrunchApi.options[:consumer_key], CrunchApi.options[:consumer_secret], {})
+      token = OAuth::AccessToken.new(consumer, CrunchApi.options[:oauth_token], CrunchApi.options[:oauth_token_secret])
+
+      uri = "#{CrunchApi.options[:endpoint]}#{path}"
+
+      response = token.get(uri)
+
+      parse_xml(response.body).collect{|xml| new(xml)}
+    end
+
+    private
+
+    def self.path
+      "/crunch-core/seam/resource/rest/api/suppliers"
+    end
+
+    def self.parse_xml(xml)
+      Nori.new(:convert_tags_to => lambda { |tag| tag.snakecase.to_sym }).parse(xml)[:crunch_message][:suppliers][:supplier]
+    end
+  end
+end

data/lib/crunch-api/version.rb

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

data/lib/crunch-api.rb

@@ -0,0 +1,39 @@
+require_relative 'crunch-api/version'
+require_relative 'crunch-api/default'
+require_relative 'crunch-api/supplier'
+
+module CrunchApi
+  class << self
+    attr_writer :consumer_key, :consumer_secret, :oauth_token, :oauth_token_secret, :endpoint
+
+    def keys
+      @keys ||= [
+          :consumer_key,
+          :consumer_secret,
+          :oauth_token,
+          :oauth_token_secret,
+          :endpoint
+      ]
+    end
+
+    def configure
+      yield self
+      self
+    end
+
+    def options
+      Hash[CrunchApi.keys.map { |key| [key, instance_variable_get(:"@#{key}")] }]
+    end
+
+    def reset!
+      CrunchApi.keys.each do |key|
+        instance_variable_set(:"@#{key}", CrunchApi::Default.options[key])
+      end
+      self
+    end
+
+    alias setup reset!
+  end
+end
+
+CrunchApi.setup

data/test/fixtures/vcr_cassettes/get_suppliers_success.yml

@@ -0,0 +1,62 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://demo.crunch.co.uk/crunch-core/seam/resource/rest/api/suppliers
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - OAuth gem v0.4.7
+      Authorization:
+      - OAuth oauth_consumer_key="aaron_chambers", oauth_nonce="xxx",
+        oauth_signature="xxx", oauth_signature_method="HMAC-SHA1",
+        oauth_timestamp="1368726069", oauth_token="xxx",
+        oauth_version="1.0"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 16 May 2013 17:41:09 GMT
+      Server:
+      - Apache
+      Set-Cookie:
+      - JSESSIONID=GRWG+Y110i1DMoYi+4lJaSyC.undefined; Path=/crunch-core; Secure
+      Cache-Control:
+      - no-cache
+      Content-Length:
+      - '1819'
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Access-Control-Allow-Headers:
+      - Origin, Content-Type, Accept, X-Requested-With, oauth_consumer_key, oauth_token,
+        oauth_signature_method, oauth_signature, oauth_timestamp, oauth_nonce, oauth_version,
+        Authorization
+      Connection:
+      - close
+      Content-Type:
+      - application/*+xml
+    body:
+      encoding: US-ASCII
+      string: <?xml version="1.0" encoding="UTF-8" standalone="yes"?><crunchMessage
+        xmlns="http://api.crunch.co.uk/rest" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        outcome="success" xsi:schemaLocation="http://api.crunch.co.uk/rest"><suppliers
+        count="6" firstResult="0"><supplier supplierId="709" defaultExpenseType="EQUIPMENT_COST"
+        resourceUrl="/crunch-core/seam/resource/rest/api/suppliers/709"><name>Apple
+        Inc</name><contactName></contactName><email>test@apple.com</email><website></website><telephone></telephone><fax></fax></supplier><supplier
+        supplierId="711" defaultExpenseType="INTERNET" resourceUrl="/crunch-core/seam/resource/rest/api/suppliers/711"><name>BT</name><contactName>Sam
+        Smith</contactName><email>sam@bt.com</email><website>bt.com</website><telephone>0712345678</telephone><fax>0212345678</fax></supplier><supplier
+        supplierId="708" resourceUrl="/crunch-core/seam/resource/rest/api/suppliers/708"><name>Currys</name><contactName></contactName><email></email><website></website><telephone></telephone><fax></fax></supplier><supplier
+        supplierId="618" defaultExpenseType="ACCOUNTANCY" resourceUrl="/crunch-core/seam/resource/rest/api/suppliers/618"><name>E-Crunch
+        Ltd</name><email>support@crunch.co.uk</email><website>www.crunch.co.uk</website><telephone>0844
+        500 8000</telephone></supplier><supplier supplierId="646" resourceUrl="/crunch-core/seam/resource/rest/api/suppliers/646"><name>Harvey
+        Norman</name><contactName></contactName><email></email><website></website><telephone></telephone><fax></fax></supplier><supplier
+        supplierId="710" defaultExpenseType="PRINTING_POSTAGE_STATIONERY" resourceUrl="/crunch-core/seam/resource/rest/api/suppliers/710"><name>Ryman</name><contactName></contactName><email></email><website></website><telephone></telephone><fax></fax></supplier></suppliers></crunchMessage>
+    http_version: 
+  recorded_at: Thu, 16 May 2013 17:41:09 GMT
+recorded_with: VCR 2.4.0

data/test/lib/crunch-api/default_test.rb

@@ -0,0 +1,44 @@
+require_relative '../../test_helper'
+
+describe CrunchApi::Default do
+
+  before do
+    @consumer_key = ENV['CRUNCH_CONSUMER_KEY']
+    ENV['CRUNCH_CONSUMER_KEY'] = "foo"
+
+    @consumer_secret = ENV['CRUNCH_CONSUMER_SECRET']
+    ENV['CRUNCH_CONSUMER_SECRET'] = "bar"
+
+    @oauth_token = ENV['CRUNCH_OAUTH_TOKEN']
+    ENV['CRUNCH_OAUTH_TOKEN'] = "woo"
+
+    @oauth_token_secret = ENV['CRUNCH_OAUTH_TOKEN_SECRET']
+    ENV['CRUNCH_OAUTH_TOKEN_SECRET'] = "war"
+  end
+
+  after do
+    ENV['CRUNCH_CONSUMER_KEY'] = @consumer_key
+    ENV['CRUNCH_CONSUMER_SECRET'] = @consumer_secret
+    ENV['CRUNCH_OAUTH_TOKEN'] = @oauth_token
+    ENV['CRUNCH_OAUTH_TOKEN_SECRET'] = @oauth_token_secret
+  end
+
+  describe "environment variables" do
+    it "returns the consumer key" do
+      CrunchApi::Default.consumer_key.must_equal "foo"
+    end
+
+    it "returns the consumer secret" do
+      CrunchApi::Default.consumer_secret.must_equal "bar"
+    end
+
+    it "returns the oauth token" do
+      CrunchApi::Default.oauth_token.must_equal "woo"
+    end
+
+    it "returns the oauth token secret" do
+      CrunchApi::Default.oauth_token_secret.must_equal "war"
+    end
+  end
+
+end

data/test/lib/crunch-api/supplier_test.rb

@@ -0,0 +1,64 @@
+require_relative '../../test_helper'
+
+describe CrunchApi::Supplier do
+  describe "Initialization" do
+    [:name, :contact_name, :email, :website, :telephone, :fax].each do |attribute|
+      it "should set the attribute for #{attribute}" do
+        supplier = CrunchApi::Supplier.new(attribute.to_sym => "foo")
+
+        supplier.send(attribute).must_equal "foo"
+      end
+    end
+
+    it "should set the attribute for id" do
+      supplier = CrunchApi::Supplier.new(:@supplierId => "foo")
+
+      supplier.id.must_equal "foo"
+    end
+
+    it "should set the attribute for uri" do
+      supplier = CrunchApi::Supplier.new(:@resourceUrl => "foo")
+
+      supplier.uri.must_equal "foo"
+    end
+
+    it "should set the attribute for default expense type" do
+      supplier = CrunchApi::Supplier.new(:@defaultExpenseType => "foo")
+
+      supplier.default_expense_type.must_equal "foo"
+    end
+
+    it "should set the attribute for unknown supplier" do
+      supplier = CrunchApi::Supplier.new(:@unknownSupplier => "true")
+
+      supplier.unknown_supplier?.must_equal true
+    end
+  end
+
+  describe "GET /suppliers" do
+    before do
+      CrunchApi.configure do |config|
+        config.endpoint = "https://demo.crunch.co.uk"
+      end
+    end
+
+    it "should call the correct resource" do
+      VCR.use_cassette('get_suppliers_success') do
+        CrunchApi::Supplier.all
+
+        assert_requested(:get, 'https://demo.crunch.co.uk/crunch-core/seam/resource/rest/api/suppliers')
+      end
+    end
+
+    it "should return an array of suppliers" do
+      VCR.use_cassette('get_suppliers_success') do
+        suppliers = CrunchApi::Supplier.all
+
+        suppliers.size.must_equal 6
+        suppliers.must_be_kind_of Array
+        suppliers.first.must_be_kind_of CrunchApi::Supplier
+        suppliers.first.name.must_equal "Apple Inc"
+      end
+    end
+  end
+end

data/test/lib/crunch-api/version_test.rb

@@ -0,0 +1,7 @@
+require_relative '../../test_helper'
+
+describe CrunchApi do
+  it "must be defined" do
+    CrunchApi::VERSION.wont_be_nil
+  end
+end

data/test/lib/crunch-api_test.rb

@@ -0,0 +1,21 @@
+require_relative '../test_helper'
+
+describe CrunchApi do
+
+  describe "configuration" do
+    after do
+      CrunchApi.reset!
+    end
+
+    [:consumer_key, :consumer_secret, :oauth_token, :oauth_token_secret, :endpoint].each do |key|
+      it "must set the attribute for #{key}" do
+        CrunchApi.configure do |config|
+          config.send("#{key}=", "foo")
+        end
+
+        CrunchApi.instance_variable_get(:"@#{key}").must_equal "foo"
+      end
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'webmock/minitest'
+require 'vcr'
+require File.expand_path('../../lib/crunch-api', __FILE__)
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'test/fixtures/vcr_cassettes'
+  config.hook_into :webmock
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: crunch-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Aaron Chambers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.7
+- !ruby/object:Gem::Dependency
+  name: nori
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.9
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: webmock
+  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: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+description: A Ruby interface to the Crunch Accounting API
+email:
+- achambers@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- crunch-api.gemspec
+- lib/crunch-api.rb
+- lib/crunch-api/default.rb
+- lib/crunch-api/supplier.rb
+- lib/crunch-api/version.rb
+- test/fixtures/vcr_cassettes/get_suppliers_success.yml
+- test/lib/crunch-api/default_test.rb
+- test/lib/crunch-api/supplier_test.rb
+- test/lib/crunch-api/version_test.rb
+- test/lib/crunch-api_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2400216506421897793
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2400216506421897793
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A Ruby interface to the Crunch Accounting API
+test_files:
+- test/fixtures/vcr_cassettes/get_suppliers_success.yml
+- test/lib/crunch-api/default_test.rb
+- test/lib/crunch-api/supplier_test.rb
+- test/lib/crunch-api/version_test.rb
+- test/lib/crunch-api_test.rb
+- test/test_helper.rb