sage_one 0.0.1

data/spec/fixtures/sales_invoices.json

@@ -0,0 +1,90 @@
+{ "$totalResults":2,
+  "$startIndex":0,
+  "$itemsPerPage":20,
+
+  "$resources":[
+  { "id":954380,
+    "invoice_number":"SI-4",
+    "status":{"id":1, "$key":1},
+    "due_date":"19/04/2013",
+    "date":"20/03/2013",
+    "void_reason":null,
+    "outstanding_amount":"17.0",
+    "total_net_amount":"14.17",
+    "total_tax_amount":"2.83",
+    "tax_scheme_period_id":30394,
+    "carriage":"0.0",
+    "carriage_tax_code":{"id":1, "$key":1},
+    "carriage_tax_rate_percentage":"20.0",
+    "contact":{"id":568085, "$key":568085},
+    "contact_name":"Luke corp (Luke Brown)",
+    "main_address":"Killer Bees",
+    "delivery_address":"",
+    "delivery_address_same_as_main":false,
+    "reference":"",
+    "notes":"future date. did email it.",
+    "terms_and_conditions":"",
+    "lock_version":0,
+    "line_items":[{
+      "id":1570294,
+      "description":"Some fish - herring",
+      "quantity":"1.0",
+      "unit_price":"17.0",
+      "net_amount":"14.17",
+      "tax_amount":"2.83",
+      "tax_code":{"id":1, "$key":1},
+      "tax_rate_percentage":"20.0",
+      "unit_price_includes_tax":true,
+      "ledger_account":{"id":1898509,
+      "$key":1898509},
+      "product_code":"HERRING",
+      "product":{"id":68656, "$key":68656},
+      "service":{"$key":null},
+      "lock_version":0,
+      "$key":1570294
+      }
+    ],
+    "$key":954380},
+    {"id":954368,
+    "invoice_number":"SI-3",
+    "status":{"id":1, "$key":1},
+    "due_date":"07/12/2012",
+    "date":"07/11/2012",
+    "void_reason":null,
+    "outstanding_amount":"19.4",
+    "total_net_amount":"16.17",
+    "total_tax_amount":"3.23",
+    "tax_scheme_period_id":30394,
+    "carriage":"2.0",
+    "carriage_tax_code":{"id":1, "$key":1},
+    "carriage_tax_rate_percentage":"20.0",
+    "contact":{"id":568085, "$key":568085},
+    "contact_name":"Luke corp (Luke Brown)",
+    "main_address":"here man.",
+    "delivery_address":"",
+    "delivery_address_same_as_main":false,
+    "reference":"",
+    "notes":"this one neither emailed nor printed.",
+    "terms_and_conditions":"",
+    "lock_version":0,
+    "line_items":[{
+      "id":1570277,
+      "description":"Some fish - herring",
+      "quantity":"1.0",
+      "unit_price":"17.0",
+      "net_amount":"14.17",
+      "tax_amount":"2.83",
+      "tax_code":{"id":1, "$key":1},
+      "tax_rate_percentage":"20.0",
+      "unit_price_includes_tax":true,
+      "ledger_account":{"id":1898509, "$key":1898509},
+      "product_code":"HERRING",
+      "product":{"id":68656, "$key":68656},
+      "service":{"$key":null},
+      "lock_version":0,
+      "$key":1570277
+      }
+    ],
+    "$key":954368}
+  ]
+}

data/spec/sage_one/client/contacts_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe SageOne::Client::Contacts do
+
+  let(:client) { SageOne.new }
+
+  describe '.contact' do
+    context 'when the contact exists' do
+      it 'returns a Hashie::Mash of the contact' do
+        stub_get('contacts/1').to_return(body: fixture('contact.json'))
+        contact = client.contact(1)
+        expect(contact).to be_a(Hashie::Mash)
+        expect(contact.name).to eq('Luke Brown')
+        expect(contact.email).to eq('luke.brown@example.com')
+      end
+    end
+  end
+
+end

data/spec/sage_one/client/sales_invoices_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe SageOne::Client::SalesInvoices do
+
+  let(:client) { SageOne.new }
+
+  describe 'sales_invoices' do
+    it 'returns an array of Hashie::Mashes, representing the available invoices' do
+      stub_get('sales_invoices').to_return(body: fixture('sales_invoices.json'))
+      inv = client.sales_invoices.first
+      expect(inv.outstanding_amount).to eq '17.0'
+      expect(inv.outstanding_amount).to eq '17.0'
+      expect(inv.notes).to eq 'future date. did email it.'
+    end
+  end
+
+  describe 'create_sales_invoice' do
+    it 'posts to the correct endpoint and returns the new invoice' do
+      stub_post('sales_invoices').to_return(body: fixture('sales_invoice.json'))
+      invoice = client.create_sales_invoice(foo: 'bar')
+      a_post('sales_invoices').with(body: { sales_invoice: { foo: 'bar' } }).should have_been_made.once
+      expect(invoice.invoice_number).to eq 'SI-4'
+    end
+  end
+
+  describe 'sales_invoice' do
+    it 'gets the requested sales invoice' do
+      stub_get('sales_invoices/333').to_return(body: fixture('sales_invoice.json'))
+      invoice = client.sales_invoice(333)
+      a_get('sales_invoices/333').should have_been_made.once
+      expect(invoice.invoice_number).to eq 'SI-4'
+    end
+  end
+
+  describe 'update_sales_invoice' do
+    it "makes a put and returns the new invoice" do
+      stub_put('sales_invoices/333').to_return(body: fixture('sales_invoice.json'))
+      invoice = client.update_sales_invoice(333, foo: 'bar')
+      a_put('sales_invoices/333').with(body: { sales_invoice: { foo: 'bar' } }).should have_been_made.once
+      expect(invoice.invoice_number).to eq 'SI-4'
+    end
+  end
+
+  describe 'delete_sales_invoice!' do
+    it "makes a delete and returns the deleted invoice" do
+      stub_delete('sales_invoices/444').to_return(body: fixture('sales_invoice.json'))
+      invoice = client.delete_sales_invoice!(444)
+      a_delete('sales_invoices/444').should have_been_made.once
+      expect(invoice.invoice_number).to eq 'SI-4'
+    end
+  end
+
+end

data/spec/sage_one/client_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe SageOne::Client do
+
+  it 'creates accessors for all the keys in the SageOne::Configuration::VALID_OPTIONS_KEYS constant' do
+    client = SageOne::Client.new
+    SageOne::Configuration::VALID_OPTIONS_KEYS.each_with_index do |method, i|
+      value = "Setting attribute #{i}"
+      client.send("#{method}=", value)
+      expect(client.send(method)).to eq(value)
+    end
+  end
+
+  describe 'initialize' do
+    it 'copies the SageOne.options to the new client' do
+      client = SageOne::Client.new
+      SageOne::Configuration::VALID_OPTIONS_KEYS.each do |method|
+        expect(client.send(method)).to eq(SageOne.options[method])
+      end
+    end
+    it 'allows you to override any config options' do
+      better_options = {
+        adapter: 'BestAdaptor',
+        faraday_config_block: 'blocky block',
+        api_endpoint: 'https://www.example.com/',
+        proxy: 'proxy.example.com',
+        access_token: 'let_me_in',
+        client_id: 'client123',
+        client_secret: 'secret',
+        user_agent: 'Gem Awesome',
+        request_host: 'example.com',
+        auto_traversal: true,
+        raw_response: true
+      }
+      client = SageOne::Client.new(better_options)
+      SageOne::Configuration::VALID_OPTIONS_KEYS.each do |method|
+        expect(client.send(method)).to eq(better_options[method])
+      end
+    end
+  end
+end

data/spec/sage_one/configuration_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe SageOne::Configuration do
+
+  subject do
+    module TestConfigModule
+      extend SageOne::Configuration
+    end
+  end
+
+  it 'has some default constants setup' do
+    expect(SageOne::Configuration::DEFAULT_ADAPTER).to eq(Faraday.default_adapter)
+    expect(SageOne::Configuration::DEFAULT_API_ENDPOINT).to eq('https://app.sageone.com/api/v1/')
+    expect(SageOne::Configuration::DEFAULT_USER_AGENT).to eq("SageOne Ruby Gem #{SageOne::VERSION}")
+    expect(SageOne::Configuration::DEFAULT_AUTO_TRAVERSAL).to be_false
+    expect(SageOne::Configuration::DEFAULT_RAW_RESPONSE).to be_false
+    expect(SageOne::Configuration::VALID_OPTIONS_KEYS).to be_a(Array)
+  end
+
+  describe 'attr_accessors' do
+    it 'creates accessors for all the keys in the VALID_OPTIONS_KEYS constant' do
+      SageOne::Configuration::VALID_OPTIONS_KEYS.reject { |k| [:api_endpoint].include?(k) }.each_with_index do |method, i|
+        value = "Setting attribute #{i}"
+        subject.send("#{method}=", value)
+        expect(subject.send(method)).to eq(value)
+      end
+    end
+    it 'uses an overridden method for setting the api_endpoint which ensures a trailing forward slash is present' do
+      subject.api_endpoint = 'http://www.example.com'
+      expect(subject.api_endpoint).to eq('http://www.example.com/')
+    end
+  end
+
+  describe "faraday_config" do
+    it 'assigns the given block to faraday_config_block' do
+      p = lambda { 'hi' }
+      subject.faraday_config(&p)
+      expect(subject.faraday_config_block.call).to eq('hi')
+    end
+  end
+
+  describe 'configure' do
+    it 'yields the given block passing in self - allowing you to config attributes' do
+      value = "my new client id"
+
+      subject.configure do |config|
+        config.client_id = value
+      end
+
+      expect(subject.client_id).to eq(value)
+    end
+  end
+
+  describe 'options' do
+    it 'returns a new hash of all the config options' do
+      expect(subject.options).to be_a(Hash)
+      expect(subject.options.keys).to eq(SageOne::Configuration::VALID_OPTIONS_KEYS)
+      expect(subject.options[:adapter]).to eq(SageOne::Configuration::DEFAULT_ADAPTER)
+    end
+  end
+
+  describe 'extended' do
+    it 'calls reset on module extending it' do
+      module NewMod; end
+      NewMod.should_receive(:reset).once
+      NewMod.extend(SageOne::Configuration)
+    end
+  end
+
+  describe 'reset' do
+    it 'resets all the config options to the default values' do
+      # Change them first
+      SageOne::Configuration::VALID_OPTIONS_KEYS.each { |method| subject.send("#{method}=", 'something') }
+      subject.reset
+      expect(subject.adapter).to eq(SageOne::Configuration::DEFAULT_ADAPTER)
+      expect(subject.api_endpoint).to eq(SageOne::Configuration::DEFAULT_API_ENDPOINT)
+      expect(subject.proxy).to be_nil
+      expect(subject.access_token).to be_nil
+      expect(subject.client_id).to be_nil
+      expect(subject.client_secret).to be_nil
+      expect(subject.request_host).to be_nil
+      expect(subject.user_agent).to eq(SageOne::Configuration::DEFAULT_USER_AGENT)
+      expect(subject.auto_traversal).to be_false
+      expect(subject.raw_response).to be_false
+    end
+  end
+
+end

data/spec/sage_one/connection_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe SageOne::Connection  do
+
+  let(:client)              { SageOne.new }
+  let(:basic_middleware)    { %w(FaradayMiddleware::EncodeJson FaradayMiddleware::OAuth2 FaradayMiddleware::RaiseSageOneException) }
+  let(:non_raw_middleware)  { %w(FaradayMiddleware::Mashify FaradayMiddleware::ParseJson) }
+
+  it "returns a Faraday" do
+    expect(client.send(:connection)).to be_a(Faraday::Connection)
+  end
+
+  it "sets up mandatory headers" do
+    headers = client.send(:connection).headers
+
+    { "Accept"        => /application\/json/,
+      "User-Agent"    => /SageOne Ruby Gem/,
+      "Content-Type"  => /application\/json/ }.each do |header, value|
+        expect(headers[header]).to match(value)
+    end
+  end
+
+  it "has the correct middleware stack" do
+    stack = client.send(:connection).builder.handlers.map(&:name)
+    (basic_middleware + non_raw_middleware).each { |mw| expect(stack).to include(mw) }
+  end
+
+  context 'raw connection requested' do
+    it 'does not include mashify or parse_json' do
+      client.raw_response = true
+      stack = client.send(:connection).builder.handlers.map(&:name)
+      (non_raw_middleware).each { |mw| expect(stack).to_not include(mw) }
+    end
+  end
+
+end

data/spec/sage_one/oauth_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe SageOne::OAuth do
+
+  let(:client) { SageOne.new(client_id: "CLIENT_ID", client_secret: "CLIENT_SECRET") }
+
+  describe 'authorize_url' do
+    it 'returns a correctly formatted url' do
+      expect(client.authorize_url('http://www.example.com/endpoint')).to eq("https://app.sageone.com/oauth/authorize/?client_id=CLIENT_ID&redirect_uri=http%3A%2F%2Fwww.example.com%2Fendpoint&response_type=code")
+    end
+  end
+
+  describe 'get_access_token' do
+    it 'returns an object containing an access_token' do
+
+      stub_post("https://app.sageone.com/oauth/token/").
+        with(:body => "{\"client_id\":\"CLIENT_ID\",\"client_secret\":\"CLIENT_SECRET\",\"grant_type\":\"authorization_code\",\"code\":\"uuddlrlr\",\"redirect_uri\":\"http://www.example.com/endpoint\"}",
+              :headers => {'Accept'=>'application/json; charset=utf-8', 'Content-Type'=>'application/json', 'User-Agent'=>'SageOne Ruby Gem 0.0.1'}).
+        to_return(:body => fixture("oauth/oauth_token.json"))
+
+      expect(client.get_access_token('uuddlrlr', 'http://www.example.com/endpoint').access_token).to eq('IguLPAK5VPvDSw3z4SjrkhHTyRXgnnqAPzt1mLUk')
+    end
+
+    describe 'failure cases' do
+      context 'invalid client' do
+        before do
+          client.client_secret = "SALMON"
+          stub_post("https://app.sageone.com/oauth/token/").to_return(status: 401, body: fixture('oauth/invalid_client.json'))
+        end
+        it { expect { client.get_access_token('uuddlrlr', 'http://www.example.com/endpoint') }.to raise_error(SageOne::Unauthorized, /invalid_client/) }
+      end
+
+      context 'wrong code' do
+        before { stub_post("https://app.sageone.com/oauth/token/").to_return(status: 400, body: fixture('oauth/invalid_grant.json')) }
+        it { expect { client.get_access_token('', 'http://www.example.com/endpoint') } .to raise_error(SageOne::BadRequest, /invalid_grant/) }
+      end
+
+      context 'wrong callback' do
+        before { stub_post("https://app.sageone.com/oauth/token/").to_return(status: 401, body: '') }
+        it { expect { client.get_access_token('uuddlrlr', 'http://www.example.com/notendpoint') }.to raise_error(SageOne::Unauthorized, %q{{"method":"post","url":"https://app.sageone.com/oauth/token/","status":401,"body":""}}) }
+      end
+    end
+  end
+end

data/spec/sage_one/request_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+describe SageOne::Request do
+
+  let(:client) { SageOne.new }
+
+  describe 'helper methods' do
+    before { client.stub(:request) }
+
+    [:get, :delete, :post, :put].each do |meth|
+      it "#{meth} exists and delegates to request" do
+        client.should_receive(:request).with(meth, 'foo', {})
+        client.send(meth, 'foo')
+      end
+    end
+  end
+
+  describe 'request' do
+    context 'get/delete' do
+      it "makes a get request" do
+        stub_get('sales_invoices')
+        client.get('sales_invoices')
+        a_get('sales_invoices').should have_been_made.once
+      end
+
+      context 'with options' do
+        it 'passes the options to the get request' do
+          stub_get('sales_invoices?start_date=2011-12-13')
+          client.get('sales_invoices', { start_date: '2011-12-13' })
+          a_get('sales_invoices?start_date=2011-12-13').should have_been_made.once
+        end
+        it 'special-cases start_index' do
+          stub_delete('sales_invoices?start_date=2011-12-13&%24startIndex=10')
+          client.delete('sales_invoices', { start_date: '2011-12-13', start_index: 10 })
+          a_delete('sales_invoices?start_date=2011-12-13&%24startIndex=10').should have_been_made.once
+        end
+      end
+    end
+    context 'put/post' do
+      it "sets the request path" do
+        stub_post('sales_invoices')
+        client.post('sales_invoices')
+        a_post('sales_invoices').should have_been_made.once
+      end
+      it "stores the options in the body" do
+        stub_put('sales_invoices')
+        client.put('sales_invoices', { "void_reason" => nil, "outstanding_amount" => "17.0", "total_net_amount" => "14.17"})
+        a_put('sales_invoices').with(body: '{"void_reason":null,"outstanding_amount":"17.0","total_net_amount":"14.17"}').should have_been_made.once
+      end
+      describe 'auto-conversion of Date-y objects' do
+        it "converts any options which are passed which resemble a date into a correctly-formatted date" do
+          stub_put('sales_invoices/222')
+          client.put('sales_invoices/222', { start_date: Time.new(2012, 10, 20), contents: { another_date: Time.new(2011, 8, 31) }})
+          a_put('sales_invoices/222').with(body: '{"start_date":"20/10/2012","contents":{"another_date":"31/08/2011"}}').should have_been_made.once
+        end
+        it "converts for any type of request, not just puts (regression test)" do
+          stub_get('sales_invoices?contents%5Banother_date%5D=31/08/2011&start_date=20/10/2012')
+          client.get('sales_invoices', { start_date: Time.new(2012, 10, 20), contents: { another_date: Time.new(2011, 8, 31) }})
+          a_get('sales_invoices?contents%5Banother_date%5D=31/08/2011&start_date=20/10/2012').should have_been_made.once
+        end
+      end
+    end
+
+    it 'Sets a request host if one is specified' do
+      client.request_host = "CustomerHost"
+      stub_get('sales_invoices')
+      client.get('sales_invoices')
+      a_get('sales_invoices').with(headers: { "Host" => 'CustomerHost' }).should have_been_made.once
+    end
+
+    describe "response body" do
+      context 'raw requested' do
+        it "returns a faraday response" do
+          stub_get('sales_invoices')
+          client.raw_response = true
+          expect(client.get('sales_invoices', {})).to be_a(Faraday::Response)
+        end
+      end
+      context 'not raw' do
+        it "returns an array of Hashie::Mash-es" do
+          stub_get('sales_invoices').to_return(body: fixture('sales_invoices.json'))
+          expect(client.get('sales_invoices')).to be_a(Array)
+          expect(client.get('sales_invoices').first).to be_a(Hashie::Mash)
+          expect(client.get('sales_invoices').first.outstanding_amount).to eq("17.0")
+          expect(client.get('sales_invoices').last).to be_a(Hashie::Mash)
+        end
+      end
+    end
+
+    context 'with auto_traversal turned on' do
+      before { client.auto_traversal = true }
+      it "recursively calls itself to build a complete result set" do
+
+        stub_get("sales_invoices").to_return(:status => 200, :body => sdata_fixture('sales_invoices.json', 30, 0, 10))
+        stub_get("sales_invoices?$startIndex=10").to_return(:status => 200, :body => sdata_fixture('sales_invoices.json', 30, 10, 10))
+        stub_get("sales_invoices?$startIndex=20").to_return(:status => 200, :body => sdata_fixture('sales_invoices.json', 30, 20, 10))
+
+        result = client.get("sales_invoices")
+
+        a_get('sales_invoices').should have_been_made.once
+        a_get('sales_invoices?$startIndex=10').should have_been_made.once
+        a_get('sales_invoices?$startIndex=20').should have_been_made.once
+
+        # The response should be three copies of the fixture file concatenated, so result[0] == result[2], etc
+        expect(result.size).to eq(6)
+        expect(result).to be_an(Array)
+        expect(result[0]).to be_a(Hashie::Mash)
+        expect(result[5]).to be_a(Hashie::Mash)
+        expect(result[0]).to eq(result[2])
+      end
+    end
+  end
+end

data/spec/sage_one/version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SageOne::VERSION do
+  it 'sets the VERSION constant' do
+    SageOne::VERSION.should_not be_nil
+  end
+end

data/spec/sage_one_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe SageOne do
+
+  describe '.new' do
+    it { SageOne.new.should be_a(SageOne::Client) }
+  end
+
+  describe '.respond_to?' do
+    it 'returns true when the method exists' do
+      expect(SageOne.respond_to?(:new, true)).to be_true
+    end
+    it 'returns true when a client responds to the method' do
+      expect(SageOne.respond_to?(:sales_invoices)).to be_true
+    end
+    it 'returns false when the method does not exist' do
+      expect(SageOne.respond_to?(:noway, true)).to be_false
+    end
+  end
+
+  describe '.method_missing' do
+    context "when the client does not respond to the method either" do
+      it 'raises a NoMethodError' do
+        expect(lambda{ SageOne.noway }).to raise_error(NoMethodError)
+      end
+    end
+    context "when the client does respond to the method" do
+      it 'delegates the call to the client, passing any args and block' do
+        block = Proc.new { puts "hi" }
+        mock_client = mock('SageOne::Client', :my_method => 'called')
+        SageOne.should_receive(:new).twice.and_return(mock_client)
+        mock_client.should_receive(:my_method).with('abc', block)
+        SageOne.my_method('abc', block)
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,76 @@
+unless ENV['CI']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter "/spec"
+  end
+end
+
+require 'sage_one'
+require 'rspec'
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end
+
+def a_delete(url)
+  a_request(:delete, sage_url(url))
+end
+
+def a_get(url)
+  a_request(:get, sage_url(url))
+end
+
+def a_patch(url)
+  a_request(:patch, sage_url(url))
+end
+
+def a_post(url)
+  a_request(:post, sage_url(url))
+end
+
+def a_put(url)
+  a_request(:put, sage_url(url))
+end
+
+def stub_delete(url)
+  stub_request(:delete, sage_url(url))
+end
+
+def stub_get(url)
+  stub_request(:get, sage_url(url))
+end
+
+def stub_post(url)
+  stub_request(:post, sage_url(url))
+end
+
+def stub_put(url)
+  stub_request(:put, sage_url(url))
+end
+
+def sage_url(url)
+  if url =~ /^http/
+    url
+  else
+    "https://app.sageone.com/api/v1/#{url}"
+  end
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end
+
+def sdata_fixture(fixture, total_results, start_index, items_per_page)
+  raw = fixture(fixture).read
+  raw.sub!(/"\$totalResults":(\d+)/, %Q("$totalResults":#{total_results}))
+  raw.sub!(/"\$startIndex":(\d+)/,   %Q("$startIndex":#{start_index}))
+  raw.sub!(/"\$itemsPerPage":(\d+)/, %Q("$itemsPerPage":#{items_per_page}))
+end