mavenlink 0.0.1

data/lib/mavenlink.rb

@@ -0,0 +1,134 @@
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/hash/slice'
+require 'active_support/core_ext/object/try'
+require 'active_support/core_ext/string/inflections'
+require 'active_model'
+require 'yaml'
+require 'json'
+require 'brainstem-adaptor'
+require 'faraday'
+
+module Mavenlink
+  VERSION = '0.0.1'
+
+  # Returns HTTP framework
+  def self.adapter
+    @adapter || Faraday.default_adapter
+  end
+
+  # @param value Any valid Faraday adapter
+  def self.adapter=(value)
+    @adapter = value
+  end
+
+  def self.client
+    @client ||= Mavenlink::Client.new
+  end
+
+  # @return [Mavenlink::Settings]
+  def self.default_settings
+    Mavenlink::Settings[:default]
+  end
+
+  def self.logger
+    @logger ||= Mavenlink::Logger.new(nil)
+  end
+
+  def self.logger=(value)
+    @logger = value
+  end
+
+  # @param token [String]
+  def self.oauth_token=(token)
+    default_settings[:oauth_token] = token
+  end
+
+  # Forces models to perform validations if true
+  # If false performs requests without running validations described in specification file
+  # Default behavior is not to validate anything
+  # @param enabled [true, false]
+  def self.perform_validations=(enabled)
+    default_settings[:perform_validations] = enabled
+  end
+
+  # @param [String] version
+  # @return [Api]
+  def self.specification
+    @specification ||= BrainstemAdaptor::Specification.new(YAML.load_file(File.join(File.dirname(__FILE__), 'config', 'specification.yml')))
+  end
+
+  def self.stub_requests(&block)
+    stubbed_requests = Faraday::Adapter::Test::Stubs.new(&block)
+    self.adapter = [:test, stubbed_requests]
+  end
+end
+
+require 'mavenlink/settings'
+require 'mavenlink/errors'
+require 'mavenlink/request'
+require 'mavenlink/response'
+require 'mavenlink/client'
+require 'mavenlink/logger'
+require 'mavenlink/concerns/custom_fieldable'
+require 'mavenlink/concerns/indestructible'
+require 'mavenlink/concerns/locked_record'
+require 'mavenlink/specificators/base'
+require 'mavenlink/specificators/attribute'
+require 'mavenlink/specificators/association'
+require 'mavenlink/specificators/validation'
+require 'mavenlink/model'
+require 'mavenlink/account_invitation'
+require 'mavenlink/account_membership'
+require 'mavenlink/additional_item'
+require 'mavenlink/assignment'
+require 'mavenlink/attachment'
+require 'mavenlink/backup_approver_association'
+require 'mavenlink/cost_rate'
+require 'mavenlink/custom_field'
+require 'mavenlink/custom_field_value'
+require 'mavenlink/custom_field_choice'
+require 'mavenlink/expense'
+require 'mavenlink/expense_category'
+require 'mavenlink/expense_report_submission'
+require 'mavenlink/external_payment'
+require 'mavenlink/fixed_fee_item'
+require 'mavenlink/external_reference'
+require 'mavenlink/holiday'
+require 'mavenlink/holiday_calendar'
+require 'mavenlink/holiday_calendar_association'
+require 'mavenlink/holiday_calendar_membership'
+require 'mavenlink/invoice'
+require 'mavenlink/organization'
+require 'mavenlink/organization_membership'
+require 'mavenlink/participation'
+require 'mavenlink/post'
+require 'mavenlink/project_template'
+require 'mavenlink/project_template_assignment'
+require 'mavenlink/skill'
+require 'mavenlink/skill_category'
+require 'mavenlink/skill_membership'
+require 'mavenlink/status_report'
+require 'mavenlink/story'
+require 'mavenlink/story_allocation_day'
+require 'mavenlink/story_dependency'
+require 'mavenlink/story_task'
+require 'mavenlink/tag'
+require 'mavenlink/time_adjustment'
+require 'mavenlink/time_entry'
+require 'mavenlink/time_off_entry'
+require 'mavenlink/timesheet_submission'
+require 'mavenlink/rate_card'
+require 'mavenlink/rate_card_role'
+require 'mavenlink/rate_card_set'
+require 'mavenlink/rate_card_set_version'
+require 'mavenlink/rate_card_version'
+require 'mavenlink/resolution'
+require 'mavenlink/role' # NOTE(SZ): remove
+require 'mavenlink/user'
+require 'mavenlink/vendor'
+require 'mavenlink/workspace'
+require 'mavenlink/workspace_invoice_preference'
+require 'mavenlink/workspace_group'
+require 'mavenlink/workweek'
+require 'mavenlink/workweek_membership'
+require 'mavenlink/railtie' if defined?(Rails)

data/lib/mavenlink/account_invitation.rb

@@ -0,0 +1,4 @@
+module Mavenlink
+  class AccountInvitation < Model
+  end
+end

data/lib/mavenlink/account_membership.rb

@@ -0,0 +1,4 @@
+module Mavenlink
+  class AccountMembership < Model
+  end
+end

data/lib/mavenlink/additional_item.rb

@@ -0,0 +1,4 @@
+module Mavenlink
+  class AdditionalItem < Model
+  end
+end

data/lib/mavenlink/assignment.rb

@@ -0,0 +1,5 @@
+module Mavenlink
+  class Assignment < Model
+    include Concerns::Indestructible
+  end
+end

data/lib/mavenlink/attachment.rb

@@ -0,0 +1,11 @@
+module Mavenlink
+  class Attachment < Model
+    include Concerns::Indestructible
+
+    protected
+
+    def update
+      raise RecordLockedError, 'The model is locked and cannot be changed'
+    end
+  end
+end

data/lib/mavenlink/backup_approver_association.rb

@@ -0,0 +1,4 @@
+module Mavenlink
+  class BackupApproverAssociation < Model
+  end
+end

data/lib/mavenlink/client.rb

@@ -0,0 +1,116 @@
+module Mavenlink
+  class Client
+    ENDPOINT = 'https://api.mavenlink.com/api/v1/'.freeze
+
+    # @param settings [ActiveSuppport::HashWithIndifferentAccess]
+    def initialize(settings = Mavenlink.default_settings)
+      @settings = settings
+      @oauth_token = settings[:oauth_token] or raise ArgumentError, 'OAuth token is not set'
+      @endpoint = settings[:endpoint] || ENDPOINT
+      @use_json = settings[:use_json]
+      if settings.key?(:user_agent_override)
+        @user_agent_override = settings[:user_agent_override]
+      end
+
+      # TODO: implement with method_missing?
+      # Declare API calls client.-->>workspaces<<---.create({})
+      Mavenlink.specification.keys.each do |collection_name|
+        singleton_class.instance_eval do
+          define_method collection_name do
+            ::Mavenlink::Request.new(collection_name, self)
+          end
+        end
+      end
+    end
+
+    # @return [Faraday::Connection]
+    def connection
+      Faraday.new(connection_options) do |builder|
+        if @use_json
+          builder.headers['Content-Type'] = 'application/json'
+        else
+          builder.use Faraday::Request::UrlEncoded
+        end
+        builder.adapter(*Mavenlink.adapter)
+      end
+    end
+
+    # Performs custom GET request
+    # @param [String] path
+    # @param [Hash] arguments
+    def get(path, arguments = {})
+      Mavenlink.logger.note "Started GET /#{path} with #{arguments.inspect}"
+      parse_request(connection.get(path, arguments).body)
+    end
+
+    # Performs custom POST request
+    # @param [String] path
+    # @param [Hash] arguments
+    def post(path, arguments = {})
+      Mavenlink.logger.note "Started POST /#{path} with #{arguments.inspect}"
+      parse_request(connection.post(path, arguments).body)
+    end
+
+    # Performs custom PUT request
+    # @param [String] path
+    # @param [Hash] arguments
+    def put(path, arguments = {})
+      Mavenlink.logger.note "Started PUT /#{path} with #{arguments.inspect}"
+      parse_request(connection.put(path, arguments).body)
+    end
+
+    # Performs custom PUT request
+    # @param [String] path
+    # @param [Hash] arguments
+    def delete(path, arguments = {})
+      Mavenlink.logger.note "Started DELETE /#{path} with #{arguments.inspect}"
+      parse_request(connection.delete(path, arguments).body)
+    end
+
+    private
+
+    attr_reader :oauth_token, :endpoint
+
+    # @return [Hash]
+    def connection_options
+      if @user_agent_override && @user_agent_override.length > 1
+        user_agent = "#{@user_agent_override}"
+      else
+        user_agent = "Mavenlink Ruby Gem"
+      end
+      {
+        headers: { 'Accept'        => "application/json",
+                   'User-Agent'    => "#{user_agent}",
+                   'Authorization' => "Bearer #{oauth_token}" },
+        ssl: { verify: false },
+        url: endpoint
+      }.freeze
+    end
+
+    def parse_request(response)
+      if response.present?
+        parsed_response = JSON.parse(response)
+      else
+        return
+      end
+
+      parsed_response.tap do
+        Mavenlink.logger.whisper 'Received response:'
+        Mavenlink.logger.inspection response
+
+        case parsed_response
+        when Array
+          Mavenlink.logger.whisper 'Returned as a plain collection'
+        when Hash
+          if parsed_response['errors']
+            Mavenlink.logger.disappointment 'REQUEST FAILED:'
+            Mavenlink.logger.inspection parsed_response['errors']
+            raise InvalidRequestError.new(parsed_response)
+          end
+        end
+      end
+    rescue JSON::ParserError => e
+      raise Mavenlink::InvalidResponseError.new(e.message)
+    end
+  end
+end

data/lib/mavenlink/concerns/custom_fieldable.rb

@@ -0,0 +1,9 @@
+module Mavenlink
+  module Concerns
+    module CustomFieldable
+      def custom_field_values
+        client.custom_field_values.filter(subject_type: self.collection_name.singularize, with_subject_id: self.id)
+      end
+    end
+  end
+end

data/lib/mavenlink/concerns/indestructible.rb

@@ -0,0 +1,11 @@
+module Mavenlink
+  module Concerns
+    module Indestructible
+
+      # @overload
+      def destroy
+        raise RecordLockedError, 'The model is locked and cannot be deleted'
+      end
+    end
+  end
+end

data/lib/mavenlink/concerns/locked_record.rb

@@ -0,0 +1,30 @@
+module Mavenlink
+  module Concerns
+    module LockedRecord
+      include Indestructible
+      extend ActiveSupport::Concern
+
+      included do
+        class << self
+          protected :new
+          protected :create
+        end
+      end
+
+      # @overload
+      def save
+        raise RecordLockedError, 'The model is locked and cannot be changed'
+      end
+
+      # @overload
+      def new_record?
+        false
+      end
+
+      # @overload
+      def persisted?
+        true
+      end
+    end
+  end
+end

data/lib/mavenlink/cost_rate.rb

@@ -0,0 +1,4 @@
+module Mavenlink
+  class CostRate < Model
+  end
+end

data/lib/mavenlink/custom_field.rb

@@ -0,0 +1,4 @@
+module Mavenlink
+  class CustomField < Model
+  end
+end

data/lib/mavenlink/custom_field_choice.rb

@@ -0,0 +1,5 @@
+module Mavenlink
+  class CustomFieldChoice < Model
+    include Concerns::LockedRecord
+  end
+end

data/lib/mavenlink/custom_field_value.rb

@@ -0,0 +1,4 @@
+module Mavenlink
+  class CustomFieldValue < Model
+  end
+end

data/lib/mavenlink/errors.rb

@@ -0,0 +1,47 @@
+module Mavenlink
+
+  # The most generic MavenlinkAPI error
+  # Eg. service unavailable etc...
+  class Error < StandardError
+  end
+
+  # Happens by internal reasons on server side
+  # Eg. client cannot parse response format
+  class InvalidResponseError < Error
+  end
+
+  # Another generic API error idenfitying that request is invalid.
+  # Eg. invalid parameters passsed in request.
+  class InvalidRequestError < Error
+    attr_reader :request
+
+    # @param request [Mavenlink::Request]
+    # @param message [String]
+    def initialize(request, message = request.inspect)
+      @request = request
+      super(message)
+    end
+  end
+
+  # Identified that a record cannot be changed.
+  # Eg. cannot be saved, removed etc.
+  class RecordLockedError < Error
+  end
+
+  # Raised when user is attmping to find unexisting record.
+  # Eg. user updates record while somebody else already removed this record.
+  class RecordNotFoundError < InvalidRequestError
+  end
+
+  # Raised when user is trying to save! record specifying invalid attributes.
+  # Eg. create! workspace without title.
+  class RecordInvalidError < Error
+    attr_reader :record # :nodoc:
+
+    # @param record [Mavenlink::Model]
+    def initialize(record)
+      @record = record
+      super(@record.errors.full_messages.join(", "))
+    end
+  end
+end

data/lib/mavenlink/expense.rb

@@ -0,0 +1,4 @@
+module Mavenlink
+  class Expense < Model
+  end
+end

data/lib/mavenlink/expense_category.rb

@@ -0,0 +1,4 @@
+module Mavenlink
+  class ExpenseCategory < Model
+  end
+end

data/lib/mavenlink/expense_report_submission.rb

@@ -0,0 +1,7 @@
+module Mavenlink
+  class ExpenseReportSubmission < Model
+    def reject_submission
+      client.put("expense_report_submissions/#{self.id}/reject")
+    end
+  end
+end