rexpense 1.0.0

data/lib/rexpense/entities/collection.rb

@@ -0,0 +1,65 @@
+module Rexpense
+  module Entities
+    #
+    # A wrapper to Rexpense collection returns from API.
+    # This wrapper represents a collection and it's responsible for
+    # processing pagination information as well.
+    #
+    class Collection < Base
+      PAGE_REGEX = /page=(\d+)/
+
+      attr_reader :response, :collection, :headers
+
+      def initialize(response)
+        @response = response
+        @collection = []
+        @headers = begin
+                     response.headers["Link"].split(",")
+                   rescue
+                     []
+                   end
+      end
+
+      def self.build(response)
+        new(response).build
+      end
+
+      def build
+        build_collection
+        self
+      end
+
+      def next_page
+        page_for(:next)
+      end
+
+      def last_page
+        page_for(:last)
+      end
+
+      def previous_page
+        page_for(:prev)
+      end
+
+      def first_page
+        page_for(:first)
+      end
+
+      private
+
+      def page_for(page_rel)
+        header_link_for(page_rel).match(PAGE_REGEX)[1].to_i
+      rescue
+        nil
+      end
+
+      def header_link_for(rel)
+        headers.select { |n| n =~ /rel=#{rel}/ }.first
+      end
+
+      def build_collection
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/rexpense/entities/comment.rb

@@ -0,0 +1,13 @@
+module Rexpense
+  module Entities
+    class Comment < Base
+      attribute :id, Integer
+      attribute :content, String
+      attribute :content_html, String
+      attribute :mentioned_users, Array[Rexpense::Entities::User]
+      attribute :user, Rexpense::Entities::User
+
+      [:created_at, :updated_at, :deleted_at].each { |n| attribute n, DateTime }
+    end
+  end
+end

data/lib/rexpense/entities/comment_collection.rb

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

data/lib/rexpense/entities/expense.rb

@@ -0,0 +1,22 @@
+module Rexpense
+  module Entities
+    class Expense < Base
+      [:id, :attachments_count, :comments_count, :activities_count,
+        :travel_time, :pre_expense_id].each { |n| attribute n, Integer }
+
+      [:description, :currency, :approved_amount_currency, :kind, :status,
+        :distance_kind, :destination, :origin].each { |n| attribute n, String }
+
+      [:amount, :approved_amount, :latitude, :longitude, :distance,
+        :destination_latitude, :destination_longitude, :origin_longitude,
+        :origin_latitude].each { |n| attribute n, Decimal }
+
+      attribute :tags, Array[String]
+      attribute :payer, Rexpense::Entities::Organization
+      attribute :receiver, Rexpense::Entities::User
+      attribute :liquidate_through_advancement, Boolean
+      attribute :created_at, DateTime
+      attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/rexpense/entities/expense_collection.rb

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

data/lib/rexpense/entities/membership.rb

@@ -0,0 +1,10 @@
+module Rexpense
+  module Entities
+    class Membership < Base
+      attribute :id, Integer
+      attribute :role, String
+      attribute :organization, Rexpense::Entities::Organization
+      attribute :user, Rexpense::Entities::User
+    end
+  end
+end

data/lib/rexpense/entities/membership_collection.rb

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

data/lib/rexpense/entities/organization.rb

@@ -0,0 +1,14 @@
+module Rexpense
+  module Entities
+    class Organization < Base
+      attribute :id, Integer
+      attribute :name, String
+      attribute :restricted_tags, Boolean
+      attribute :expired, Boolean
+      attribute :members_count, Integer
+      attribute :logo, Array[Hash]
+
+      [:created_at, :updated_at].each { |n| attribute n, String }
+    end
+  end
+end

data/lib/rexpense/entities/organization_collection.rb

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

data/lib/rexpense/entities/pre_expense.rb

@@ -0,0 +1,17 @@
+module Rexpense
+  module Entities
+    class PreExpense < Base
+      attribute :id, Integer
+      attribute :amount, Decimal
+
+      [:description, :currency].each { |n| attribute n, String }
+
+      [:created_at, :converted_at, :updated_at,
+       :ignored_at, :occurred_at].each { |n| attribute n, String }
+
+      attribute :tags, Array[String]
+      attribute :payer, Rexpense::Entities::Organization
+      attribute :receiver, Rexpense::Entities::User
+    end
+  end
+end

data/lib/rexpense/entities/pre_expense_collection.rb

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

data/lib/rexpense/entities/reimbursement.rb

@@ -0,0 +1,14 @@
+module Rexpense
+  module Entities
+    class Reimbursement < 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/reimbursement_collection.rb

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

data/lib/rexpense/entities/tag.rb

@@ -0,0 +1,8 @@
+module Rexpense
+  module Entities
+    class Tag < Base
+      attribute :id, Integer
+      attribute :name, String
+    end
+  end
+end

data/lib/rexpense/entities/tag_collection.rb

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

data/lib/rexpense/entities/user.rb

@@ -0,0 +1,14 @@
+module Rexpense
+  module Entities
+    class User < Base
+      attribute :id, Integer
+      attribute :first_name, String
+      attribute :last_name, String
+      attribute :mention_name, String
+      attribute :default_currency, String
+      attribute :name, String
+      attribute :avatar, Array[Hash]
+      attribute :default_avatar, Boolean
+    end
+  end
+end

data/lib/rexpense/entities/user_collection.rb

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

data/lib/rexpense/entities/webhook.rb

@@ -0,0 +1,10 @@
+module Rexpense
+  module Entities
+    class Webhook < Base
+      attribute :id, Integer
+      attribute :url, String
+      attribute :description, String
+      attribute :secret, String
+    end
+  end
+end

data/lib/rexpense/entities/webhook_collection.rb

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

data/lib/rexpense/exception.rb

@@ -0,0 +1,11 @@
+module Rexpense
+  class Exception < StandardError
+    attr_accessor :code, :body
+
+    def initialize(args = {})
+      super(args[:message])
+      @code     = args[:code]
+      @body     = args[:body]
+    end
+  end
+end

data/lib/rexpense/http.rb

@@ -0,0 +1,41 @@
+require "rexpense/request"
+require "rexpense/response"
+
+module Rexpense
+  class Http
+    attr_reader :token, :base_url
+
+    SANDBOX_URL = "https://sandbox.rexpense.com/api"
+    PRODUCTION_URL = "https://app.rexpense.com/api"
+
+    def initialize(token)
+      @token = token
+      @base_url = api_url + "/#{Rexpense.configuration.version}"
+    end
+
+    %w[get post delete put patch].each do |m|
+      define_method(m) do |path, options = {}, &block|
+        send_request(m.to_sym, path, options, &block)
+      end
+    end
+
+    private
+
+    def api_url
+      return PRODUCTION_URL if Rexpense.configuration.api_mode == 'production'
+      SANDBOX_URL
+    end
+
+    def send_request(method, path, options, &block)
+      request = Request.new(
+        options.merge!(
+          method: method,
+          token: token,
+          url: "#{base_url}#{path}",
+          user_agent: Rexpense.configuration.user_agent
+        )
+      )
+      Response.new(request.run).resolve!(&block)
+    end
+  end
+end

data/lib/rexpense/request.rb

@@ -0,0 +1,56 @@
+module Rexpense
+  class Request
+    def initialize(args)
+      @args = args
+    end
+
+    def run
+      request.run
+      request.response
+    end
+
+    private
+
+    attr_reader :args
+
+    def request
+      @request ||= Typhoeus::Request.new(args[:url], options)
+    end
+
+    def options
+      {
+        method:           args[:method],
+        params:           args[:params],
+        body:             body,
+        headers:          headers,
+        accept_encoding:  "gzip",
+        params_encoding: :rack
+      }.reject { |_k, v| v.nil? }
+    end
+
+    def headers
+      headers = args.fetch(:headers) { {} }
+
+      {
+        "Accept"         => "application/json",
+        "Content-Type"   => content_type,
+        "User-Agent"     => args[:user_agent],
+        "Authorization"  => "Basic #{authorization_hash}"
+      }.merge(headers).delete_if { |_, v| v.nil? || v.to_s.empty? }
+    end
+
+    def body
+      body = args[:body]
+      body = JSON.dump(body) if body.is_a?(Hash) && !args[:multipart]
+      body
+    end
+
+    def authorization_hash
+      ::Base64.strict_encode64("#{args[:token]}:X")
+    end
+
+    def content_type
+      args[:multipart] ? nil : "application/json"
+    end
+  end
+end

data/lib/rexpense/resources/activity.rb

@@ -0,0 +1,24 @@
+module Rexpense
+  module Resources
+    #
+    # A wrapper to Rexpense activity API
+    #
+    # [API]
+    #   Documentation: http://developers.rexpense.com/api/v1/activities/
+    #
+    class Activity < Base
+      #
+      # Get user activities
+      #
+      # [API]
+      #   Method: <tt>GET /api/v1/activities</tt>
+      #
+      #   Documentation: http://developers.rexpense.com/api/activities#index
+      def find_all
+        http.get('/activities') do |response|
+          Rexpense::Entities::ActivityCollection.build response
+        end
+      end
+    end
+  end
+end

data/lib/rexpense/resources/advancement.rb

@@ -0,0 +1,20 @@
+module Rexpense
+  module Resources
+    #
+    # A wrapper to Rexpense advancements API
+    #
+    # [API]
+    #   Documentation: http://developers.rexpense.com/api/v1/advancements/
+    #
+    class Advancement < ResourceBase
+      include Rexpense::Resources::Comment
+      include Rexpense::Resources::Participant
+
+      private
+
+      def endpoint_base
+        "/advancements"
+      end
+    end
+  end
+end

data/lib/rexpense/resources/advancement_devolution.rb

@@ -0,0 +1,36 @@
+module Rexpense
+  module Resources
+    #
+    # A wrapper to Rexpense advancement_devolutions API
+    #
+    # [API]
+    #   Documentation: http://developers.rexpense.com/api/v1/advancement_devolutions/
+    #
+    class AdvancementDevolution < Base
+
+      #
+      # Create a resource
+      #
+      # [API]
+      #   Method: <tt>POST /api/v1/expenses</tt>
+      #   Method: <tt>POST /api/v1/advancements</tt>
+      #   Method: <tt>POST /api/v1/reimbursements</tt>
+      #
+      #   Documentation: http://developers.rexpense.com/api/v1/expenses/#create
+      #   Documentation: http://developers.rexpense.com/api/v1/advancements/#create
+      #   Documentation: http://developers.rexpense.com/api/v1/reimbursements/#create
+      #
+      def create(params)
+        http.post("#{endpoint_base}", body: params) do |response|
+          respond_with_object response
+        end
+      end
+
+      private
+
+      def endpoint_base
+        "/advancement_devolutions"
+      end
+    end
+  end
+end

data/lib/rexpense/resources/base.rb

@@ -0,0 +1,52 @@
+module Rexpense
+  module Resources
+    class Base
+
+      attr_accessor :http
+
+      def initialize(http)
+        @http = http
+      end
+
+      private
+
+      def build_search_endpoint(params)
+        return URI.encode("#{endpoint_base}") if params.empty?
+        query_string = uri_query(params).join("&")
+        URI.encode("#{endpoint_base}?#{query_string}")
+      end
+
+      def uri_query(params)
+        page = params.delete(:page)
+        query = []
+        params.each { |k, v| query += query_value(k, v) }
+        query << "page=#{page}" if page
+        query
+      end
+
+      def query_value(key, value)
+        [].tap do |query|
+          if value.is_a?(Array)
+            value.each { |v| query << "q[#{key}][]=#{v}" }
+          else
+            query << "q[#{key}]=#{value}"
+          end
+        end
+      end
+
+      def respond_with_collection(response)
+        collection_klass = Rexpense::Entities.const_get("#{entity_klass_name}Collection")
+        collection_klass.build(response)
+      end
+
+      def respond_with_object(response, key=nil)
+        entity_klass = Rexpense::Entities.const_get(entity_klass_name)
+        entity_klass.new(response.parsed_body(key))
+      end
+
+      def entity_klass_name
+        self.class.to_s.gsub("Resources", "Entities")
+      end
+    end
+  end
+end

data/lib/rexpense/resources/expense.rb

@@ -0,0 +1,39 @@
+module Rexpense
+  module Resources
+    #
+    # A wrapper to Rexpense expenses API
+    #
+    # [API]
+    #   Documentation: http://developers.rexpense.com/api/v1/expenses/
+    #
+    class Expense < ResourceBase
+      include Rexpense::Resources::Comment
+      include Rexpense::Resources::Participant
+      include Rexpense::Resources::Attachment
+
+      def status(id)
+        http.get("#{search_endpoint}/#{id}/status") do |response|
+          Rexpense::Entities::ExpenseStatus.new response.parsed_body
+        end
+      end
+
+      def update_status(id, params)
+        http.put("#{search_endpoint}/#{id}/status", body: params) do |response|
+          Rexpense::Entities::ExpenseStatus.new response.parsed_body
+        end
+      end
+
+      def mentionables(id)
+        http.get("#{endpoint_base}/#{id}/mentionables") do |response|
+          Rexpense::Entities::UserCollection.build response.parsed_body
+        end
+      end
+
+      private
+
+      def endpoint_base
+        "/expenses"
+      end
+    end
+  end
+end

data/lib/rexpense/resources/nested_endpoints/attachment.rb

@@ -0,0 +1,48 @@
+module Rexpense::Resources
+  module Attachment
+    #
+    # Get resource attachments
+    #
+    # [API]
+    #   Method: <tt>GET /api/v1/expenses/:id/attachments</tt>
+    #
+    #   Documentation: http://developers.rexpense.com/api/attachments#index
+    def attachments(resource_id)
+      http.get(attachment_endpoint(resource_id)) do |response|
+        Rexpense::Entities::AttachmentCollection.build response
+      end
+    end
+
+    #
+    # Get resource attachment
+    #
+    # [API]
+    #   Method: <tt>GET /api/v1/expenses/:id/attachments/:id</tt>
+    #
+    #   Documentation: http://developers.rexpense.com/api/attachments#show
+    def find_attachment(resource_id, attachment_id)
+      http.get("#{attachment_endpoint(resource_id)}/#{attachment_id}") do |response|
+        Rexpense::Entities::Attachment.new response.parsed_body
+      end
+    end
+
+    #
+    # Destroy resource attachment
+    #
+    # [API]
+    #   Method: <tt>DELETE /api/v1/expenses/:id/attachments/:id</tt>
+    #
+    #   Documentation: http://developers.rexpense.com/api/attachments#show
+    def destroy_attachment(resource_id, attachment_id)
+      http.delete("#{attachment_endpoint(resource_id)}/#{attachment_id}") do |response|
+        true
+      end
+    end
+
+    private
+
+    def attachment_endpoint(resource_id)
+      "#{endpoint_base}/#{resource_id}/attachments"
+    end
+  end
+end