rexpense 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b1af2d47bc17b54e64a8ba213fde5cc7c40b6f35
+  data.tar.gz: 8bf8a3f461624bc05bfbf697f8548a463282acf9
+SHA512:
+  metadata.gz: 4f7aa47c7b07b5794b083011d0628448d80ae6b77fcb6796ceae0856061ae36f0ff652e32191d850d1297afbc984aefbfd2953a04de23dbd5bb81afd42382414
+  data.tar.gz: 7747b7ba92d585a6a0c5fdce8b8d9d43012569b0df9d856c70ec0aee21f09c8e3286c42042e70682ead815677c3e2ed249ad962a3868597b6a4d645a01be39b8

data/.codeclimate.yml

@@ -0,0 +1,22 @@
+---
+engines:
+  bundler-audit:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - Gemfile.lock
+  - "**.rb"
+exclude_paths:
+- spec/
+- coverage/
+- pkg/
+- tmp/

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+*.swp
+.DS_Store
+.bundle
+.config
+.env
+.envrc
+.rspec-local
+.ruby-*
+.rvmrc
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

@@ -0,0 +1,2 @@
+--format progress
+--color

data/.rubocop.yml

@@ -0,0 +1,54 @@
+AllCops:
+  DisplayCopNames: true
+  Exclude:
+    - "rexpense.gemspec"
+    - "Gemfile"
+
+Metrics/LineLength:
+  StyleGuide: "https://github.com/bbatsov/ruby-style-guide#80-character-limits"
+  Max: 120
+
+Metrics/BlockLength:
+  Enabled: false
+  Exclude:
+    - "**/*_spec.rb"
+
+Metrics/ModuleLength:
+  Exclude:
+    - "**/*_spec.rb"
+
+Style/Alias:
+  EnforcedStyle: "prefer_alias_method"
+
+Style/AsciiComments:
+  StyleGuide: "https://github.com/bbatsov/ruby-style-guide#english-comments"
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/ParallelAssignment:
+  StyleGuide: "https://github.com/bbatsov/ruby-style-guide#parallel-assignment"
+  Enabled: false
+
+Style/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: space
+
+Style/StringLiterals:
+  StyleGuide: "https://github.com/bbatsov/ruby-style-guide#consistent-string-literals"
+  EnforcedStyle: double_quotes
+Style/PercentLiteralDelimiters:
+  StyleGuide: "https://github.com/bbatsov/ruby-style-guide#percent-literal-braces"
+  PreferredDelimiters:
+    default: ()
+    '%i': '[]'
+    '%I': '[]'
+    '%r': '{}'
+    '%w': '[]'
+    '%W': '[]'

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.2.0
+  - 2.3.4
+script:
+  - bundle exec rake --trace spec
+before_install:
+  - gem update bundler

data/CHANGELOG.md

@@ -0,0 +1 @@
+# Changelog

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,97 @@
+PATH
+  remote: .
+  specs:
+    rexpense (1.0.0)
+      mime-types (~> 2.99)
+      require_all (~> 1.4.0)
+      typhoeus (~> 0.8)
+      virtus (~> 1.0.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
+    awesome_print (1.7.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    codeclimate-test-reporter (0.6.0)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coderay (1.1.1)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    equalizer (0.0.11)
+    ethon (0.10.1)
+      ffi (>= 1.3.0)
+    ffi (1.9.18)
+    ice_nine (0.11.2)
+    json (2.0.3)
+    method_source (0.8.2)
+    mime-types (2.99.3)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-nav (0.2.4)
+      pry (>= 0.9.10, < 0.11.0)
+    public_suffix (2.0.5)
+    rake (10.5.0)
+    require_all (1.4.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    safe_yaml (1.0.4)
+    simplecov (0.13.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    thread_safe (0.3.6)
+    typhoeus (0.8.0)
+      ethon (>= 0.8.0)
+    vcr (2.9.3)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+    webmock (1.9.3)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print (~> 1.1)
+  codeclimate-test-reporter (~> 0.4)
+  pry (~> 0.9)
+  pry-nav (~> 0.2)
+  rake (~> 10.0)
+  rexpense!
+  rspec
+  simplecov (~> 0.9)
+  vcr (~> 2.4)
+  webmock (~> 1.9.3)
+
+BUNDLED WITH
+   1.15.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Eduardo Hertz
+
+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,195 @@
+# rexpense-client-ruby
+
+A Ruby client for the [Rexpense](http://www.rexpense.com) REST API
+
+[![Gem version](https://badge.fury.io/rb/rexpense.png)](https://rubygems.org/gems/rexpense)
+[![Build status](https://travis-ci.org/myfreecomm/rexpense-client-ruby.png?branch=master)](https://travis-ci.org/myfreecomm/rexpense-client-ruby)
+[![Test coverage](https://codeclimate.com/github/myfreecomm/rexpense-client-ruby/badges/coverage.svg)](https://codeclimate.com/github/myfreecomm/v-client-ruby)
+[![Code Climate grade](https://codeclimate.com/github/myfreecomm/rexpense-client-ruby.png)](https://codeclimate.com/github/myfreecomm/rexpense-client-ruby)
+
+Rexpense API docs: http://developers.rexpense.com
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rexpense'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rexpense
+
+## Configuration
+
+Use `Rexpense.configure` to setup your environment:
+
+```ruby
+require 'rexpense'
+
+Rexpense.configure do |config|
+  config.api_mode = 'production' # To set the rexpense application that will use
+  config.version = 'v1' # Current API version
+  config.user_agent = 'My App v1.0' # optional, but you should pass a custom user-agent identifying your app
+end
+```
+
+## Usage
+
+##### Given your token, create an instance of Rexpense::Client, as below:
+
+```ruby
+client = Rexpense.client("YOUR_TOKEN_HERE")
+```
+
+##### Now you have access to these API endpoints:
+
+
+### Available Endpoints
+
+- [Advancement Participants](http://developers.rexpense.com/api/v1/advancement_participants/)
+```ruby
+  client.advancements.participants(:advancement_id)
+  client.advancements.leave_participant(:advancement_id)
+```
+- [Reimbursement Participants](http://developers.rexpense.com/api/v1/reimbursement_participants/)
+```ruby
+  client.reimbursements.participants(:reimbursement_id)
+  client.reimbursements.leave_participant(:reimbursement_id)
+```
+
+- [Expense Participants](http://developers.rexpense.com/api/v1/expense_participants/)
+```ruby
+  client.expenses.participants(:expense_id)
+  client.expenses.leave_participant(:expense_id)
+```
+
+- [Comments](http://developers.rexpense.com/api/v1/comments/)
+```ruby
+  client.advancements.comments(:advancement_id)
+  client.advancements.find_comment(:advancement_id, :comment_id)
+  client.advancements.create_comment(:advancement_id, params)
+  client.advancements.update_comment(:advancement_id, :comment_id, params)
+  client.advancements.destroy_comment(:advancement_id, :comment_id)
+
+  client.reimbursement.comments(:advancement_id)
+  client.reimbursement.find_comment(:advancement_id, :comment_id)
+  client.reimbursement.create_comment(:advancement_id, params)
+  client.reimbursement.update_comment(:advancement_id, :comment_id, params)
+  client.reimbursement.destroy_comment(:advancement_id, :comment_id)
+
+  client.expenses.comments(:advancement_id)
+  client.expenses.find_comment(:advancement_id, :comment_id)
+  client.expenses.create_comment(:advancement_id, params)
+  client.expenses.update_comment(:advancement_id, :comment_id, params)
+  client.expenses.destroy_comment(:advancement_id, :comment_id)
+```
+
+- [Activities](http://developers.rexpense.com/api/v1/activities/)
+```ruby
+  client.activitites.find_all
+```
+
+- [Advancements](http://developers.rexpense.com/api/v1/advancements/)
+```ruby
+  client.advancements.find_all
+  client.advancements.find(:advancement_id)
+  client.advancements.create(params)
+  client.advancements.update(:advancement_id, params)
+  client.advancements.destroy(:advancement_id)
+```
+
+- [Advancement Devolutions](http://developers.rexpense.com/api/v1/advancement_devolutions/)
+```ruby
+  client.advancement_devolutions.create
+```
+
+- [Expenses](http://developers.rexpense.com/api/v1/expenses/)
+```ruby
+  client.expenses.find_all
+  client.expenses.find(:expense_id)
+  client.expenses.create(params)
+  client.expenses.update(:expense_id, params)
+  client.expenses.destroy(:expense_id)
+```
+
+- [Organizations](http://developers.rexpense.com/api/v1/organizations/)
+```ruby
+  client.organizations.find_all
+  client.organizations.find(:organization_id)
+  client.organizations.update(:organization_id, params)
+  client.organizations.destroy(:organization_id)
+```
+
+- [Memberships](http://developers.rexpense.com/api/v1/memberships/)
+```ruby
+  client.organizations.memberships(:organization_id)
+  client.organizations.find_memberships(:organization_id, :membership_id)
+  client.organizations.create_memberships(:organization_id, params)
+  client.organizations.update_memberships(:organization_id, :membership_id, params)
+  client.organizations.destroy_memberships(:organization_id, :membership_id)
+```
+
+- [PreExpenses](http://developers.rexpense.com/api/v1/pre_expenses/)
+```ruby
+  client.pre_expenses.find_all
+  client.pre_expenses.find(:pre_expense_id)
+  client.pre_expenses.ignore(:pre_expense_id)
+  client.pre_expenses.restore(:pre_expense_id)
+  client.pre_expenses.convert(:pre_expense_id, params)
+```
+
+- [Tags](http://developers.rexpense.com/api/v1/tags/)
+```ruby
+  client.tags.find_all(:organization_id)
+  client.tags.find(:organization_id, :tag_id)
+  client.tags.create(:organization_id, params)
+  client.tags.update(:organization_id, :tag_id, params)
+  client.tags.destroy(:organization_id, :tag_id)
+```
+
+- [Webhooks](http://developers.rexpense.com/api/v1/webhooks/)
+```ruby
+  client.webhooks.find_all(:organization_id)
+  client.webhooks.find(:organization_id, :webhook_id)
+  client.webhooks.create(:organization_id, params)
+  client.webhooks.update(:organization_id, :webhook_id, params)
+  client.webhooks.destroy(:organization_id, :webhook_id)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Release
+
+To release a new version, update the version number in `lib/rexpense/version.rb`, run `bundle install` and commit & push the changes to the repository.
+
+If this is your first time publishing a RubyGem in your local device, you will have to download your credentials. To do this, follow the instructions in your [profile page in RubyGems](https://rubygems.org/profile/edit) or just type the following in your command line, replacing `$username` with your RubyGems username.
+
+```bash
+$ curl -u $username https://rubygems.org/api/v1/api_key.yaml > ~/.gem/credentials; chmod 0600 ~/.gem/credentials
+```
+
+Then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). Make sure you have publishing rights for the gem on RubyGems beforehand, though.
+
+After publishing the new version, add a comment to each pull request that was included in this release like this:
+
+```
+:shipit: released on [version x.y.z](https://rubygems.org/gems/rexpense/versions/x.y.z)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/myfreecomm/rexpense-client-ruby. This project is intended to be a safe and welcoming space for collaboration.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rexpense"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/rspec

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+begin
+  load File.expand_path("../spring", __FILE__)
+rescue LoadError => e
+  raise unless e.message.include?("spring")
+end
+#
+# This file was generated by Bundler.
+#
+# The application "rspec" is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+                                           Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rexpense/client.rb

@@ -0,0 +1,39 @@
+require "rexpense/request"
+require "rexpense/response"
+
+module Rexpense
+  class Client
+    attr_reader :http
+
+    def initialize(token)
+      @http = Http.new(token)
+    end
+
+    def authenticated?
+      http.get("/organizations") { |response| response.code == 200 }
+    rescue RequestError => e
+      raise e unless [401, 403].include?(e.code)
+      false
+    end
+
+    # Define available endpoints
+
+    def activities
+      Rexpense::Resources::Activity.new(http)
+    end
+
+    def advancement_devolutions
+      Rexpense::Resources::AdvancementDevolution.new(http)
+    end
+
+    def pre_expenses
+      Rexpense::Resources::PreExpense.new(http)
+    end
+
+    %w(organization expense advancement reimbursement tag webhook membership comment user).each do |endpoint|
+      define_method(endpoint + 's') do
+        Object.const_get("Rexpense::Resources::#{endpoint.capitalize}").new(http)
+      end
+    end
+  end
+end

data/lib/rexpense/configuration.rb

@@ -0,0 +1,13 @@
+require "base64"
+
+module Rexpense
+  class Configuration
+    attr_accessor :user_agent, :api_mode, :version
+
+    def initialize
+      @api_mode = 'production'
+      @version = 'v1'
+      @user_agent = "Rexpense Ruby Client v#{Rexpense::VERSION}"
+    end
+  end
+end

data/lib/rexpense/entities/activity.rb

@@ -0,0 +1,11 @@
+module Rexpense
+  module Entities
+    class Activity < Base
+      attribute :id, Integer
+      attribute :subject, Hash
+      attribute :source, Hash
+      attribute :user, Rexpense::Entities::Organization
+      attribute :changes, String
+    end
+  end
+end

data/lib/rexpense/entities/activity_collection.rb

@@ -0,0 +1,14 @@
+module Rexpense
+  module Entities
+    #
+    # A wrapper to Activity collection
+    #
+    class ActivityCollection < Collection
+      def build_collection
+        response.parsed_body['activities'].each do |attributes|
+          collection.push(Rexpense::Entities::Activity.new(attributes))
+        end
+      end
+    end
+  end
+end

data/lib/rexpense/entities/advancement.rb

@@ -0,0 +1,14 @@
+module Rexpense
+  module Entities
+    class Advancement < Base
+      [:id, :comments_count, :activities_count].each { |n| attribute n, Integer }
+      [:description, :currency].each { |n| attribute n, String }
+      attribute :amount, Decimal
+      attribute :tags, Array[String]
+      attribute :created_at, DateTime
+      attribute :updated_at, DateTime
+      attribute :payer, Rexpense::Entities::Organization
+      attribute :receiver, Rexpense::Entities::User
+    end
+  end
+end

data/lib/rexpense/entities/advancement_collection.rb

@@ -0,0 +1,14 @@
+module Rexpense
+  module Entities
+    #
+    # A wrapper to Advancement collection
+    #
+    class AdvancementCollection < Collection
+      def build_collection
+        response.parsed_body['advancements'].each do |attributes|
+          collection.push(Rexpense::Entities::Advancement.new(attributes))
+        end
+      end
+    end
+  end
+end

data/lib/rexpense/entities/advancement_devolution.rb

@@ -0,0 +1,13 @@
+module Rexpense
+  module Entities
+    class AdvancementDevolution < Base
+      attribute :id, Integer
+      attribute :currency, String
+      attribute :amount, Decimal
+      attribute :deleted_at, DateTime
+      attribute :date, DateTime
+      attribute :payer, Rexpense::Entities::Organization
+      attribute :receiver, Rexpense::Entities::User
+    end
+  end
+end

data/lib/rexpense/entities/attachment.rb

@@ -0,0 +1,13 @@
+module Rexpense
+  module Entities
+    class Attachment < Base
+      attribute :id, Integer
+      attribute :description, String
+      attribute :content_type, String
+      attribute :file_name, String
+      attribute :url, String
+      attribute :user, Rexpense::Entities::User
+      attribute :uploaded_at, DateTime
+    end
+  end
+end

data/lib/rexpense/entities/attachment_collection.rb

@@ -0,0 +1,14 @@
+module Rexpense
+  module Entities
+    #
+    # A wrapper to Attachment collection
+    #
+    class AttachmentCollection < Collection
+      def build_collection
+        response.parsed_body['attachments'].each do |attributes|
+          collection.push(Rexpense::Entities::Attachment.new(attributes))
+        end
+      end
+    end
+  end
+end

data/lib/rexpense/entities/base.rb

@@ -0,0 +1,9 @@
+require "virtus"
+
+module Rexpense
+  module Entities
+    class Base
+      include Virtus.model
+    end
+  end
+end