rexpense 1.0.0

data/rexpense.gemspec

@@ -0,0 +1,48 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rexpense/version"
+
+Gem::Specification.new do |spec|
+  spec.name                 = "rexpense"
+  spec.version              = Rexpense::VERSION
+  spec.authors              = ["Eduardo Hertz", "Dante Alighieri"]
+  spec.email                = [
+    "dante.alighierimds@gmail.com",
+    "eduardohertz@gmail.com",
+  ]
+  spec.required_ruby_version = ">= 2.0.0"
+
+  spec.summary       = %q{A Ruby client for the Rexpense REST API}
+  spec.description   = %q{A Ruby client for the Rexpense REST API: http://developers.rexpense.com}
+  spec.homepage      = "https://github.com/myfreecomm/rexpense-client-ruby"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting "allowed_push_host", or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files`.split($/).reject { |f| f =~ %r{(vcr_cassettes)/} }
+  spec.bindir        = "bin"
+  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 "typhoeus", "~> 0.8"
+  spec.add_dependency "virtus", "~> 1.0.5"
+  spec.add_dependency "mime-types", "~> 2.99"
+  spec.add_dependency "require_all", "~> 1.4.0"
+
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "vcr", "~> 2.4"
+  spec.add_development_dependency "webmock", "~> 1.9.3"
+  spec.add_development_dependency "pry", "~> 0.9"
+  spec.add_development_dependency "pry-nav", "~> 0.2"
+  spec.add_development_dependency "awesome_print", "~> 1.1"
+  spec.add_development_dependency "simplecov", "~> 0.9"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4"
+end

data/spec/lib/rexpense/client_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+describe Rexpense::Client do
+  subject { client }
+
+  shared_examples :resource do |method, type|
+    describe "##{method}" do
+      it "instantiates a new #{type}" do
+        allow(type).to receive(:new)
+        subject.send(method)
+        expect(type).to have_received(:new).with(subject.http)
+      end
+    end
+  end
+
+  describe "#initialize" do
+    it "instantiates a new Rexpense::Http object" do
+      expect(Rexpense::Http).to receive(:new).with("abc")
+      Rexpense::Client.new("abc")
+    end
+
+    context "when account_id is present" do
+      it "instantiates a new Rexpense::Http object" do
+        expect(Rexpense::Http).to receive(:new).with("abc")
+        Rexpense::Client.new("abc")
+      end
+    end
+  end
+
+  describe "#authenticated?" do
+    context "with a valid token" do
+      it "returns true" do
+        VCR.use_cassette("client/authenticated/true") { expect(subject.authenticated?).to be_truthy }
+      end
+    end
+
+    context "with an invalid token" do
+      subject { described_class.new("FAKE-TOKEN") }
+
+      it "returns false" do
+        VCR.use_cassette("client/authenticated/false") { expect(subject.authenticated?).to be_falsey }
+      end
+    end
+  end
+
+  # include_examples :resource, :entities, Rexpense::Resources::Entity
+end

data/spec/lib/rexpense/configuration_spec.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Rexpense::Configuration do
+  subject { Rexpense::Configuration.new }
+
+  it "uses the production mode by default" do
+    expect(subject.api_mode).to eq("production")
+  end
+
+  it "uses a default user agent" do
+    expect(subject.user_agent).to eq("Rexpense Ruby Client v#{Rexpense::VERSION}")
+  end
+
+  it 'allows setting the configuration parameters' do
+    subject.api_mode = "sandbox"
+    subject.user_agent = "My specific user agent"
+
+    expect(subject.api_mode).to eq("sandbox")
+    expect(subject.user_agent).to eq("My specific user agent")
+  end
+
+  it 'does not respond to #token' do
+    expect(subject).to_not respond_to(:token)
+  end
+end

data/spec/lib/rexpense/entities/activity_collection_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Rexpense::Entities::ActivityCollection do
+  it_behaves_like :entity_collection, Rexpense::Entities::Activity, 'activities'
+end

data/spec/lib/rexpense/entities/activity_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Rexpense::Entities::Activity do
+  subject { described_class.new({}) }
+
+  it_behaves_like "entity_attributes", [
+    :id, :subject, :source, :user, :changes
+  ]
+end

data/spec/lib/rexpense/entities/advancement_collection_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Rexpense::Entities::AdvancementCollection do
+  it_behaves_like :entity_collection, Rexpense::Entities::Advancement, 'advancements'
+end

data/spec/lib/rexpense/entities/advancement_devolution_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Rexpense::Entities::AdvancementDevolution do
+  subject { described_class.new({}) }
+
+  it_behaves_like "entity_attributes", [
+    :id, :currency, :amount, :deleted_at, :date, :payer, :receiver
+  ]
+end

data/spec/lib/rexpense/entities/advancement_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Rexpense::Entities::Advancement do
+  subject { described_class.new({}) }
+
+  it_behaves_like "entity_attributes", [
+    :id, :comments_count, :activities_count, :description, :currency,
+    :amount, :tags, :created_at, :updated_at, :payer, :receiver
+  ]
+end

data/spec/lib/rexpense/entities/base_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+describe Rexpense::Entities::Base do
+
+  class DummyEntity < Rexpense::Entities::Base
+    attribute :property_1, String
+    attribute :property_2, String
+  end
+
+  let(:hash) { { property_1: 1, property_2: 2 } }
+  subject    { DummyEntity.new(hash) }
+
+  it "builds an object from a hash" do
+    expect(subject).to respond_to(:property_1)
+    expect(subject).to respond_to(:property_2)
+    expect(subject.property_1).to eq("1")
+    expect(subject.property_2).to eq("2")
+  end
+
+  describe "#attributes" do
+    it "returns a hash from object attributes" do
+      expect(subject.to_hash).to eq({
+        property_1: "1",
+        property_2: "2"
+      })
+    end
+  end
+end

data/spec/lib/rexpense/entities/collection_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Rexpense::Entities::Collection do
+  let(:response) { double(headers: {"Link" => "<https://sandbox.rexpense.com/api/v1/expenses?page=3>; rel=next, <https://sandbox.rexpense.com/api/v1/expenses?page=1>; rel=prev, <https://sandbox.rexpense.com/api/v1/expenses?page=3>; rel=last, <https://sandbox.rexpense.com/api/v1/expenses?page=1>; rel=first" },
+                          body: "[]") }
+
+  subject { described_class.new(response) }
+
+  describe '#build' do
+    it 'raises NotImplementedError' do
+      expect { subject.build }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe '#next_page' do
+    it 'returns next page (3)' do
+      expect(subject.next_page).to eq(3)
+    end
+
+    context 'when there is no next page' do
+      let(:response) { double(headers: {"Link" => ""}, body: "") }
+
+      it 'returns nil' do
+        expect(subject.next_page).to be_nil
+      end
+    end
+  end
+
+  describe '#last_page' do
+    it 'returns last page (3)' do
+      expect(subject.last_page).to eq(3)
+    end
+
+    context 'when there is no last page' do
+      let(:response) { double(headers: {"Link" => ""}, body: "") }
+
+      it 'returns nil' do
+        expect(subject.last_page).to be_nil
+      end
+    end
+  end
+
+  describe '#previous_page' do
+    it 'returns previous page (3)' do
+      expect(subject.previous_page).to eq(1)
+    end
+
+    context 'when there is no previous page' do
+      let(:response) { double(headers: {"Link" => ""}, body: "") }
+
+      it 'returns nil' do
+        expect(subject.previous_page).to be_nil
+      end
+    end
+  end
+
+  describe '#first_page' do
+    it 'returns first page (3)' do
+      expect(subject.first_page).to eq(1)
+    end
+
+    context 'when there is no first page' do
+      let(:response) { double(headers: {"Link" => ""}, body: "") }
+
+      it 'returns nil' do
+        expect(subject.first_page).to be_nil
+      end
+    end
+  end
+end

data/spec/lib/rexpense/entities/comment_collection_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Rexpense::Entities::CommentCollection do
+  it_behaves_like :entity_collection, Rexpense::Entities::Comment, 'comments'
+end

data/spec/lib/rexpense/entities/comment_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Rexpense::Entities::Comment do
+  subject { described_class.new({}) }
+
+  it_behaves_like "entity_attributes", [
+    :id, :content, :content_html, :mentioned_users, :user,
+    :created_at, :updated_at, :deleted_at
+  ]
+end

data/spec/lib/rexpense/entities/expense_collection_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Rexpense::Entities::ExpenseCollection do
+  it_behaves_like :entity_collection, Rexpense::Entities::Expense, 'expenses'
+end

data/spec/lib/rexpense/entities/expense_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Rexpense::Entities::Expense do
+  subject { described_class.new({}) }
+
+  it_behaves_like "entity_attributes", [
+    :id, :attachments_count, :comments_count, :activities_count, :travel_time,
+    :description, :currency, :approved_amount_currency, :kind, :status,
+    :distance_kind, :destination, :origin, :amount, :approved_amount, :latitude,
+    :longitude, :distance, :destination_latitude, :destination_longitude,
+    :origin_longitude, :origin_latitude, :tags, :liquidate_through_advancement,
+    :created_at, :updated_at, :pre_expense_id, :payer, :receiver
+  ]
+end

data/spec/lib/rexpense/entities/membership_collection_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Rexpense::Entities::MembershipCollection do
+  it_behaves_like :entity_collection, Rexpense::Entities::Membership, 'memberships'
+end

data/spec/lib/rexpense/entities/membership_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Rexpense::Entities::Membership do
+  subject { described_class.new({}) }
+
+  it_behaves_like "entity_attributes", [:id, :role, :organization, :user]
+end

data/spec/lib/rexpense/entities/organization_collection_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Rexpense::Entities::OrganizationCollection do
+  it_behaves_like :entity_collection, Rexpense::Entities::Organization, 'organizations'
+end

data/spec/lib/rexpense/entities/organization_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Rexpense::Entities::Organization do
+  subject { described_class.new({}) }
+
+  it_behaves_like "entity_attributes", [:id, :name, :restricted_tags, :expired,
+  :members_count, :logo, :created_at, :updated_at]
+end

data/spec/lib/rexpense/entities/pre_expense_collection_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Rexpense::Entities::PreExpenseCollection do
+  it_behaves_like :entity_collection, Rexpense::Entities::PreExpense, 'pre_expenses'
+end

data/spec/lib/rexpense/entities/pre_expense_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Rexpense::Entities::PreExpense do
+  subject { described_class.new({}) }
+
+  it_behaves_like "entity_attributes", [
+    :id, :amount, :description, :currency, :created_at, :converted_at, :updated_at,
+    :ignored_at, :occurred_at, :tags, :payer, :receiver
+  ]
+end

data/spec/lib/rexpense/entities/reimbursement_collection_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Rexpense::Entities::ReimbursementCollection do
+  it_behaves_like :entity_collection, Rexpense::Entities::Reimbursement, 'reimbursements'
+end

data/spec/lib/rexpense/entities/reimbursement_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Rexpense::Entities::Reimbursement do
+  subject { described_class.new({}) }
+
+  it_behaves_like "entity_attributes", [
+    :id, :comments_count, :activities_count, :description, :currency,
+    :amount, :tags, :created_at, :updated_at, :payer, :receiver
+  ]
+end

data/spec/lib/rexpense/entities/user_collection_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Rexpense::Entities::UserCollection do
+  it_behaves_like :entity_collection, Rexpense::Entities::User, 'participants'
+end

data/spec/lib/rexpense/entities/user_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Rexpense::Entities::User do
+  subject { described_class.new({}) }
+
+  it_behaves_like "entity_attributes", [
+    :id, :first_name, :last_name, :mention_name,
+    :default_currency, :name, :avatar, :default_avatar
+  ]
+end

data/spec/lib/rexpense/entities/webhook_collection_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Rexpense::Entities::WebhookCollection do
+  it_behaves_like :entity_collection, Rexpense::Entities::Webhook, 'webhooks'
+end

data/spec/lib/rexpense/entities/webhook_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Rexpense::Entities::Webhook do
+  subject { described_class.new({}) }
+
+  it_behaves_like "entity_attributes", [:id, :url, :description, :secret]
+end

data/spec/lib/rexpense/http_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Rexpense::Http do
+  subject { Rexpense::Http.new('8cd049b4afca9213fb2455528394ab2fb0bc34f5c905f33c') }
+
+  describe '#get' do
+    let(:http_method) { :get }
+    let(:url) { '/organizations/68/tags' }
+    let(:params) { {} }
+
+    it_behaves_like 'available http request methods'
+  end
+
+  describe '#post' do
+    let(:http_method) { :post }
+    let(:url) { '/organizations/68/tags' }
+    let(:params) { { name: 'Rexpense gem client' } }
+
+    it_behaves_like 'available http request methods'
+  end
+
+  describe '#put' do
+    let(:http_method) { :put }
+    let(:url) { '/organizations/68/tags/172' }
+    let(:params) { { name: 'Rexpense gem client 02' } }
+
+    it_behaves_like 'available http request methods'
+  end
+
+  describe '#delete' do
+    let(:http_method) { :delete }
+    let(:url) { '/organizations/68/tags/114' }
+    let(:params) { {} }
+
+    it_behaves_like 'available http request methods'
+  end
+end

data/spec/lib/rexpense/request_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+describe Rexpense::Request do
+  describe "#run" do
+    subject { described_class.new({ method: 'post', params: {}, url: 'https://sandbox.rexpense.com', user_agent: 'My Test User-Agent', token: 'my-auth-hash' }) }
+
+    it "does a request using Typhoeus::Request" do
+      expect(Typhoeus::Request).to receive(:new).with("https://sandbox.rexpense.com", { method: "post", params: {}, headers: { "Accept" => "application/json", "Content-Type" => "application/json", "User-Agent" => "My Test User-Agent", "Authorization" => "Basic bXktYXV0aC1oYXNoOlg=" }, accept_encoding: "gzip", params_encoding: :rack }).and_return(double(run: true, response: true))
+      subject.run
+    end
+
+    it "invokes Typhoeus::Request#run" do
+      expect_any_instance_of(Typhoeus::Request).to receive(:run)
+      subject.run
+    end
+
+    it "invokes Typhoeus::Request#response" do
+      allow_any_instance_of(Typhoeus::Request).to receive(:run)
+      expect_any_instance_of(Typhoeus::Request).to receive(:response)
+      subject.run
+    end
+
+    it "generates the base 64 of the user token" do
+      allow_any_instance_of(Typhoeus::Request).to receive(:run)
+      expect(Base64).to receive(:strict_encode64).with("my-auth-hash:X").and_call_original
+      subject.run
+    end
+  end
+end

data/spec/lib/rexpense/resources/activity_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Rexpense::Resources::Activity, vcr: true do
+  let(:activity_klass) { Rexpense::Entities::Activity }
+
+  describe "#find_all" do
+    context "with success" do
+      subject { client.activities.find_all }
+
+      it "show all activities successfully" do
+        expect(subject.class).to eq(Rexpense::Entities::ActivityCollection)
+        expect(subject.collection.first.class).to eq(activity_klass)
+      end
+    end
+  end
+end

data/spec/lib/rexpense/resources/advancement_devolution_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Rexpense::Resources::AdvancementDevolution, vcr: true do
+  let(:devolution_klass) { Rexpense::Entities::AdvancementDevolution }
+
+  describe "#create" do
+    let(:params) do
+      {
+        payer_id: 35, receiver_id: 2, amount: 10.10,
+        currency: 'BRL', date: '27/09/2017'
+      }
+    end
+
+
+    it 'create a new devolution' do
+      result = client.advancement_devolutions.create(params)
+      expect(result).to be_a(devolution_klass)
+      expect(result.amount).to eq(10.10)
+    end
+
+    context "with error" do
+      it "raises Rexpense::RequestError with 422 status code" do
+        expect { client.advancement_devolutions.create({}) }.to raise_error(Rexpense::RequestError) do |error|
+          expect(error.code).to eq(422)
+        end
+      end
+    end
+  end
+end