rexpense 1.0.0

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

@@ -0,0 +1,84 @@
+module Rexpense::Resources
+  module Comment
+    #
+    # Get resource comments
+    #
+    # [API]
+    #   Method: <tt>GET /api/v1/reimbursements/:id/comments</tt>
+    #   Method: <tt>GET /api/v1/expenses/:id/comments</tt>
+    #   Method: <tt>GET /api/v1/advancements/:id/comments</tt>
+    #
+    #   Documentation: http://developers.rexpense.com/api/comments#index
+    def comments(resource_id)
+      http.get(comment_endpoint(resource_id)) do |response|
+        Rexpense::Entities::CommentCollection.build response
+      end
+    end
+
+    #
+    # Get resource comment
+    #
+    # [API]
+    #   Method: <tt>GET /api/v1/reimbursements/:id/comments/:comment_id</tt>
+    #   Method: <tt>GET /api/v1/expenses/:id/comments/:comment_id</tt>
+    #   Method: <tt>GET /api/v1/advancements/:id/comments/:comment_id</tt>
+    #
+    #   Documentation: http://developers.rexpense.com/api/comments#show
+    def find_comment(resource_id, comment_id)
+      http.get("#{comment_endpoint(resource_id)}/#{comment_id}") do |response|
+        Rexpense::Entities::Comment.new response.parsed_body
+      end
+    end
+
+    #
+    # Create resource comment
+    #
+    # [API]
+    #   Method: <tt>POST /api/v1/reimbursements/:id/comments</tt>
+    #   Method: <tt>POST /api/v1/expenses/:id/comments</tt>
+    #   Method: <tt>POST /api/v1/advancements/:id/comments</tt>
+    #
+    #   Documentation: http://developers.rexpense.com/api/comments#create
+    def create_comment(resource_id, params)
+      http.post(comment_endpoint(resource_id), body: params) do |response|
+        Rexpense::Entities::Comment.new response.parsed_body
+      end
+    end
+
+    #
+    # Update resource comment
+    #
+    # [API]
+    #   Method: <tt>PUT /api/v1/reimbursements/:id/comments/:comment_id</tt>
+    #   Method: <tt>PUT /api/v1/expenses/:id/comments/:comment_id</tt>
+    #   Method: <tt>PUT /api/v1/advancements/:id/comments/:comment_id</tt>
+    #
+    #   Documentation: http://developers.rexpense.com/api/comments#update
+    def update_comment(resource_id, comment_id, params)
+      http.put("#{comment_endpoint(resource_id)}/#{comment_id}", body: params) do |response|
+        Rexpense::Entities::Comment.new response.parsed_body
+      end
+    end
+
+    #
+    # Destroy resource comment
+    #
+    # [API]
+    #   Method: <tt>DELETE /api/v1/reimbursements/:id/comments/:comment_id</tt>
+    #   Method: <tt>DELETE /api/v1/expenses/:id/comments/:comment_id</tt>
+    #   Method: <tt>DELETE /api/v1/advancements/:id/comments/:comment_id</tt>
+    #
+    #   Documentation: http://developers.rexpense.com/api/comments#destroy
+    def destroy_comment(resource_id, comment_id)
+      http.delete("#{comment_endpoint(resource_id)}/#{comment_id}") do |response|
+        true
+      end
+    end
+
+    private
+
+    def comment_endpoint(resource_id)
+      "#{endpoint_base}/#{resource_id}/comments"
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+module Rexpense::Resources
+  module Membership
+    #
+    # Get organization memberships
+    #
+    # [API]
+    #   Method: <tt>GET /api/v1/organizations/:id/memberships</tt>
+    #
+    #   Documentation: http://developers.rexpense.com/api/memberships#index
+    def memberships(organization_id)
+      http.get(membership_endpoint(organization_id)) do |response|
+        Rexpense::Entities::MembershipCollection.build response
+      end
+    end
+
+    #
+    # Get organization membership
+    #
+    # [API]
+    #   Method: <tt>GET /api/v1/organizations/:id/memberships/:membership_id</tt>
+    #
+    #   Documentation: http://developers.rexpense.com/api/memberships#show
+    def find_membership(organization_id, membership_id)
+      http.get("#{membership_endpoint(organization_id)}/#{membership_id}") do |response|
+        Rexpense::Entities::Membership.new response.parsed_body
+      end
+    end
+
+    #
+    # Create organization membership
+    #
+    # [API]
+    #   Method: <tt>POST /api/v1/organizations/:id/memberships</tt>
+    #
+    #   Documentation: http://developers.rexpense.com/api/memberships#create
+    def create_membership(organization_id, params)
+      http.post(membership_endpoint(organization_id), body: params) do |response|
+        response.parsed_body
+      end
+    end
+
+    #
+    # Update organization membership
+    #
+    # [API]
+    #   Method: <tt>PUT /api/v1/organizations/:id/memberships/:membership_id</tt>
+    #
+    #   Documentation: http://developers.rexpense.com/api/memberships#update
+    def update_membership(organization_id, membership_id, params)
+      http.put("#{membership_endpoint(organization_id)}/#{membership_id}", body: params) do |response|
+        Rexpense::Entities::Membership.new response.parsed_body
+      end
+    end
+
+    #
+    # Destroy organization membership
+    #
+    # [API]
+    #   Method: <tt>DELETE /api/v1/organizations/:id/memberships/:membership_id</tt>
+    #
+    #   Documentation: http://developers.rexpense.com/api/memberships#destroy
+    def destroy_membership(organization_id, membership_id)
+      http.delete("#{membership_endpoint(organization_id)}/#{membership_id}") do |response|
+        true
+      end
+    end
+
+    private
+
+    def membership_endpoint(organization_id)
+      "#{endpoint_base}/#{organization_id}/members"
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module Rexpense::Resources
+  module Participant
+    #
+    # Get resource participants tags
+    #
+    # [API]
+    #   Method: <tt>GET /api/v1/reimbursements/:id/participants</tt>
+    #   Method: <tt>GET /api/v1/expenses/:id/participants</tt>
+    #   Method: <tt>GET /api/v1/advancements/:id/participants</tt>
+    #
+    #   Documentation: http://developers.rexpense.com/api/participants#index
+    #   Documentation: http://developers.rexpense.com/api/expense_participants#index
+    #   Documentation: http://developers.rexpense.com/api/reimbursement_participants#index
+    def participants(resource_id)
+      http.get(participants_endpoint(resource_id)) do |response|
+        Rexpense::Entities::UserCollection.build response
+      end
+    end
+
+    #
+    # Get resource participants tags
+    #
+    # [API]
+    #   Method: <tt>GET /api/v1/reimbursements/:id/participants</tt>
+    #   Method: <tt>GET /api/v1/expenses/:id/participants</tt>
+    #   Method: <tt>GET /api/v1/advancements/:id/participants</tt>
+    #
+    #   Documentation: http://developers.rexpense.com/api/advancement_participants#destroy
+    #   Documentation: http://developers.rexpense.com/api/expense_participants#destroy
+    #   Documentation: http://developers.rexpense.com/api/reimbursement_participants#destroy
+    def leave_participant(resource_id)
+      http.delete(participants_endpoint(resource_id)) do |response|
+        true
+      end
+    end
+
+    private
+
+    def participants_endpoint(resource_id)
+      "#{endpoint_base}/#{resource_id}/participants"
+    end
+  end
+end

data/lib/rexpense/resources/organization.rb

@@ -0,0 +1,31 @@
+module Rexpense
+  module Resources
+    #
+    # A wrapper to Rexpense organizations API
+    #
+    # [API]
+    #   Documentation: http://developers.rexpense.com/api/v1/organizations/
+    #
+    class Organization < ResourceBase
+      include Rexpense::Resources::Membership
+
+      def distances_rules(id)
+        http.get("#{endpoint_base}/#{id}/distances_rules") do |response|
+          response.parsed_body.first
+        end
+      end
+
+      def update_distances_rules(id, params)
+        http.post("#{endpoint_base}/#{id}/distances_rules", body: params) do |response|
+          response.parsed_body.first
+        end
+      end
+
+      private
+
+      def endpoint_base
+        "/organizations"
+      end
+    end
+  end
+end

data/lib/rexpense/resources/pre_expense.rb

@@ -0,0 +1,56 @@
+module Rexpense
+  module Resources
+    #
+    # A wrapper to Rexpense pre_expenses API
+    #
+    # [API]
+    #   Documentation: http://developers.rexpense.com/api/v1/pre_expenses/
+    #
+    class PreExpense < ResourceBase
+      #
+      # Ignore a pre_expense resource
+      #
+      # [API]
+      #   Method: <tt>PUT /api/v1/pre_expenses/ignore</tt>
+      #
+      #   Documentation: http://developers.rexpense.com/api/v1/pre_expenses/#ignore
+      def ignore(id)
+        http.put("#{endpoint_base}/#{id}/ignore") do |response|
+          respond_with_object response
+        end
+      end
+
+      #
+      # Restore a pre_expense resource
+      #
+      # [API]
+      #   Method: <tt>PUT /api/v1/pre_expenses/restore</tt>
+      #
+      #   Documentation: http://developers.rexpense.com/api/v1/pre_expenses/#ignore
+      def restore(id)
+        http.put("#{endpoint_base}/#{id}/restore") do |response|
+          respond_with_object response
+        end
+      end
+
+      #
+      # Restore a pre_expense resource
+      #
+      # [API]
+      #   Method: <tt>POST /api/v1/pre_expenses/convert</tt>
+      #
+      #   Documentation: http://developers.rexpense.com/api/v1/pre_expenses/#convert
+      def convert(id, params={})
+        http.post("#{endpoint_base}/#{id}/convert", body: params) do |response|
+          Rexpense::Entities::Expense.new response.parsed_body
+        end
+      end
+
+      private
+
+      def endpoint_base
+        "/pre_expenses"
+      end
+    end
+  end
+end

data/lib/rexpense/resources/reimbursement.rb

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

data/lib/rexpense/resources/resource_base.rb

@@ -0,0 +1,105 @@
+module Rexpense
+  module Resources
+    #
+    # A wrapper to Rexpense resources API
+    #
+    # [API]
+    #   Documentation: http://developers.rexpense.com/api/v1/expenses/
+    #   Documentation: http://developers.rexpense.com/api/v1/advancements/
+    #   Documentation: http://developers.rexpense.com/api/v1/reimbursements/
+    #
+    class ResourceBase < Base
+      #
+      # List all resources
+      #
+      # [API]
+      #   Method: <tt>GET /api/v1/expenses</tt>
+      #   Method: <tt>GET /api/v1/advancements</tt>
+      #   Method: <tt>GET /api/v1/reimbursements</tt>
+      #
+      #   Documentation: http://developers.rexpense.com/api/v1/expenses/#index
+      #   Documentation: http://developers.rexpense.com/api/v1/advancements/#index
+      #   Documentation: http://developers.rexpense.com/api/v1/reimbursements/#index
+      #
+      def find_all(params = {})
+        search_endpoint = build_search_endpoint(params)
+
+        http.get(search_endpoint) do |response|
+          respond_with_collection(response)
+        end
+      end
+
+      #
+      # Find a resource
+      #
+      # [API]
+      #   Method: <tt>GET /api/v1/expenses/:id</tt>
+      #   Method: <tt>GET /api/v1/advancements/:id</tt>
+      #   Method: <tt>GET /api/v1/reimbursements/:id</tt>
+      #
+      #   Documentation: http://developers.rexpense.com/api/v1/expenses/#show
+      #   Documentation: http://developers.rexpense.com/api/v1/advancements/#show
+      #   Documentation: http://developers.rexpense.com/api/v1/reimbursements/#show
+      #
+      def find(id)
+        http.get("#{endpoint_base}/#{id}", body: {}) do |response|
+          respond_with_object response
+        end
+      end
+
+      #
+      # 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
+
+      #
+      # Updates a resource
+      #
+      # [API]
+      #   Method: <tt>PATCH /api/v1/expenses/:id</tt>
+      #   Method: <tt>PATCH /api/v1/advancements/:id</tt>
+      #   Method: <tt>PATCH /api/v1/reimbursements/:id</tt>
+      #
+      #   Documentation: http://developers.rexpense.com/api/v1/expenses/#update
+      #   Documentation: http://developers.rexpense.com/api/v1/advancements/#update
+      #   Documentation: http://developers.rexpense.com/api/v1/reimbursements/#update
+      #
+      def update(id, params = {})
+        http.patch("#{endpoint_base}/#{id}", body: params) do |response|
+          respond_with_object response
+        end
+      end
+
+      #
+      # Destroy a resource
+      #
+      # [API]
+      #   Method: <tt>DELETE /api/v1/expenses/:id</tt>
+      #   Method: <tt>DELETE /api/v1/advancements/:id</tt>
+      #   Method: <tt>DELETE /api/v1/reimbursements/:id</tt>
+      #
+      #   Documentation: http://developers.rexpense.com/api/v1/expenses/#destroy
+      #   Documentation: http://developers.rexpense.com/api/v1/advancements/#destroy
+      #   Documentation: http://developers.rexpense.com/api/v1/reimbursements/#destroy
+      #
+      def destroy(id)
+        http.delete("#{endpoint_base}/#{id}", body: {}) do |response|
+          true
+        end
+      end
+    end
+  end
+end

data/lib/rexpense/resources/tag.rb

@@ -0,0 +1,82 @@
+module Rexpense
+  module Resources
+    #
+    # A wrapper to Rexpense Tag API
+    #
+    # [API]
+    #   Documentation: http://developers.rexpense.com/api/v1/tags
+    #
+    class Tag < ResourceBase
+      #
+      # Get organization tags
+      #
+      # [API]
+      #   Method: <tt>GET /api/v1/organization/:id/tags</tt>
+      #
+      #   Documentation: http://developers.rexpense.com/api/tags#index
+      def find_all(id)
+        http.get(endpoint_base(id)) do |response|
+          Rexpense::Entities::TagCollection.build response
+        end
+      end
+
+      #
+      # Find a organization tag
+      #
+      # [API]
+      #   Method: <tt>GET /api/v1/organization/:id/tags/:tag_id</tt>
+      #
+      #   Documentation: http://developers.rexpense.com/api/tags#show
+      def find(id, tag_id)
+        http.get("#{endpoint_base(id)}/#{tag_id}") do |response|
+          Rexpense::Entities::Tag.new response.parsed_body
+        end
+      end
+
+      #
+      # Create a organization tag
+      #
+      # [API]
+      #   Method: <tt>POST /api/v1/organization/:id/tags</tt>
+      #
+      #   Documentation: http://developers.rexpense.com/api/tags#create
+      def create(id, params={})
+        http.post(endpoint_base(id), body: params) do |response|
+          Rexpense::Entities::Tag.new response.parsed_body
+        end
+      end
+
+      #
+      # Update a organization tag
+      #
+      # [API]
+      #   Method: <tt>PUT /api/v1/organization/:id/tags/:tag_id</tt>
+      #
+      #   Documentation: http://developers.rexpense.com/api/tags#update
+      def update(id, tag_id, params={})
+        http.put("#{endpoint_base(id)}/#{tag_id}", body: params) do |response|
+          Rexpense::Entities::Tag.new response.parsed_body
+        end
+      end
+
+      #
+      # Create a organization tag
+      #
+      # [API]
+      #   Method: <tt>DELETE /api/v1/organization/:id/tags/:tag_id</tt>
+      #
+      #   Documentation: http://developers.rexpense.com/api/tags#destroy
+      def destroy(id, tag_id)
+        http.delete("#{endpoint_base(id)}/#{tag_id}") do |response|
+          true
+        end
+      end
+
+      private
+
+      def endpoint_base(id)
+        "/organizations/#{id}/tags"
+      end
+    end
+  end
+end

data/lib/rexpense/resources/webhook.rb

@@ -0,0 +1,82 @@
+module Rexpense
+  module Resources
+    #
+    # A wrapper to Rexpense organizations API
+    #
+    # [API]
+    #   Documentation: http://developers.rexpense.com/api/v1/organizations/
+    #
+    class Webhook < Base
+      #
+      # Get organization webhooks
+      #
+      # [API]
+      #   Method: <tt>GET /api/v1/organization/:id/integrations/webhooks</tt>
+      #
+      #   Documentation: http://developers.rexpense.com/api/webhooks#index
+      def find_all(id)
+        http.get(endpoint_base(id)) do |response|
+          Rexpense::Entities::WebhookCollection.build response
+        end
+      end
+
+      #
+      # Find a organization Webhook
+      #
+      # [API]
+      #   Method: <tt>GET /api/v1/organization/:id/integrations/webhooks/:webhook_id</tt>
+      #
+      #   Documentation: http://developers.rexpense.com/api/webhooks#show
+      def find(id, webhook_id)
+        http.get("#{endpoint_base(id)}/#{webhook_id}") do |response|
+          Rexpense::Entities::Webhook.new response.parsed_body
+        end
+      end
+
+      #
+      # Create a organization Webhook
+      #
+      # [API]
+      #   Method: <tt>POST /api/v1/organization/:id/integrations/webhooks</tt>
+      #
+      #   Documentation: http://developers.rexpense.com/api/webhooks#create
+      def create(id, params={})
+        http.post(endpoint_base(id), body: params) do |response|
+          Rexpense::Entities::Webhook.new response.parsed_body
+        end
+      end
+
+      #
+      # Update a organization Webhook
+      #
+      # [API]
+      #   Method: <tt>PUT /api/v1/organization/:id/integrations/webhooks/:webhook_id</tt>
+      #
+      #   Documentation: http://developers.rexpense.com/api/webhooks#update
+      def update(id, webhook_id, params={})
+        http.put("#{endpoint_base(id)}/#{webhook_id}", body: params) do |response|
+          Rexpense::Entities::Webhook.new response.parsed_body
+        end
+      end
+
+      #
+      # Create a organization Webhook
+      #
+      # [API]
+      #   Method: <tt>DELETE /api/v1/organization/:id/integrations/webhooks/:webhook_id</tt>
+      #
+      #   Documentation: http://developers.rexpense.com/api/webhooks#destroy
+      def destroy(id, webhook_id)
+        http.delete("#{endpoint_base(id)}/#{webhook_id}") do |response|
+          true
+        end
+      end
+
+      private
+
+      def endpoint_base(id)
+        "/organizations/#{id}/integrations/webhooks"
+      end
+    end
+  end
+end

data/lib/rexpense/response.rb

@@ -0,0 +1,43 @@
+require "rexpense/exception"
+
+module Rexpense
+  class RequestTimeout < Exception; end
+  class RequestError < Exception; end
+
+  class Response < SimpleDelegator
+    def resolve!
+      if success?
+        block_given? ? yield(self) : self
+      elsif timed_out?
+        raise RequestTimeout
+      else
+        error!
+      end
+    end
+
+    def parsed_body(key = nil)
+      return JSON.parse(body)[key] unless key.nil?
+      JSON.parse(body)
+    rescue JSON::ParserError
+      {}
+    end
+
+    private
+
+    def error!
+      raise RequestError.new(
+        code:    code,
+        message: request_error_message,
+        body:    parsed_body
+      )
+    end
+
+    def request_error_message
+      if !status_message.nil? && status_message != ""
+        status_message
+      else
+        parsed_body["error"] || ""
+      end
+    end
+  end
+end

data/lib/rexpense/version.rb

@@ -0,0 +1,3 @@
+module Rexpense
+  VERSION = "1.0.0".freeze
+end

data/lib/rexpense.rb

@@ -0,0 +1,19 @@
+require "typhoeus"
+require "mime/types"
+require "require_all"
+
+require_rel "rexpense"
+
+module Rexpense
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration) if block_given?
+  end
+
+  def self.client(token)
+    Client.new(token)
+  end
+end