mavenlink 0.0.1

data/lib/mavenlink/external_payment.rb

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

data/lib/mavenlink/external_reference.rb

@@ -0,0 +1,24 @@
+module Mavenlink
+  class ExternalReference < Model
+    def save
+      if valid?
+        reload(create_or_update(attributes_for_create_or_update))
+        true
+      else
+        false
+      end
+    end
+
+    private
+
+    def create_or_update(attributes)
+      request.perform do
+        client.post("external_references/create_or_update", { external_reference: attributes})
+      end
+    end
+
+    def attributes_for_create_or_update
+      specification_attributes("create_or_update_attributes")
+    end
+  end
+end

data/lib/mavenlink/fixed_fee_item.rb

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

data/lib/mavenlink/holiday.rb

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

data/lib/mavenlink/holiday_calendar.rb

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

data/lib/mavenlink/holiday_calendar_association.rb

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

data/lib/mavenlink/holiday_calendar_membership.rb

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

data/lib/mavenlink/invoice.rb

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

data/lib/mavenlink/logger.rb

@@ -0,0 +1,62 @@
+module Mavenlink
+  class Logger < ::Logger
+    # @todo(SZ) YARD, docu, describe colors, when to use each one
+
+    # @param device [nil, STDOUT, STDERR]
+    def initialize(device)
+      super
+      self.level = Logger::FATAL
+    end
+
+    # @param [String] message
+    def disappointment(message)
+      info("\e[#{35}m[Maven]\e[0m \e[#{31}m#{message}\e[0m") if error?
+    end
+
+    # @param [String] message
+    def hint(message)
+      info("\e[#{32}m[Maven]\e[1m \e[#{33}m#{message}\e[0m") if warn?
+    end
+
+    # @param [String] message
+    def note(message)
+      info("\e[#{32}m[Maven]\e[0m \e[#{36}m#{message}\e[0m") if info?
+    end
+
+    # @param [String] message
+    def whisper(message)
+      info("\e[#{32}m[Maven]\e[0m \e[#{37}m#{message}\e[0m") if debug?
+    end
+
+    # @param [String] message
+    def inspection(message)
+      if debug?
+        if message.respond_to?(:awesome_inspect)
+          info(message.awesome_inspect)
+        else
+          info(message.inspect)
+        end
+      end
+    end
+
+    # @param [String] message
+    def self.disappointment(message)
+      Mavenlink.logger.disappointment(message)
+    end
+
+    # @param [String] message
+    def self.hint(message)
+      Mavenlink.logger.hint(message)
+    end
+
+    # @param [String] message
+    def self.note(message)
+      Mavenlink.logger.note(message)
+    end
+
+    # @param [String] message
+    def self.whisper(message)
+      Mavenlink.logger.whisper(message)
+    end
+  end
+end

data/lib/mavenlink/model.rb

@@ -0,0 +1,279 @@
+module Mavenlink
+  class Model < BrainstemAdaptor::Record
+    include ActiveModel::Validations
+
+    attr_reader :client
+
+    class << self
+      delegate :only, :find, :search, :filter, :page, :total_count, :per_page, :limit, :offset, :order, :all, to: :scoped
+    end
+
+    # @return [String]
+    def self.collection_name
+      (self.name || 'undefined').split(/\W+/).last.tableize.pluralize
+    end
+
+    # @param attributes [Hash]
+    # @return [Mavenlink::Model]
+    def self.create(attributes = {})
+      self.new(attributes).tap(&:save)
+    end
+
+    # @raise [Mavenlink::RecordInvalidError]
+    # @param attributes [Hash]
+    # @return [Mavenlink::Model]
+    def self.create!(attributes = {})
+      create(attributes).tap do |record|
+        record.valid? or raise RecordInvalidError.new(record)
+      end
+    end
+
+    # @return [Mavenlink::Request]
+    def self.includes(*args)
+      scoped.include(*args)
+    end
+
+    # @param client [Mavenlink::Client]
+    # @return [Mavenlink::Request]
+    def self.scoped(client = Mavenlink.client)
+      Mavenlink::Request.new(collection_name, client)
+    end
+
+    # @return [Mavenlink::Request]
+    def scoped_im
+      Mavenlink::Request.new(collection_name, client)
+    end
+
+    # @param model_class [Mavenlink::Model]
+    def self.inherited(model_class)
+      ::Mavenlink::Model.models[model_class.collection_name] = model_class
+
+      # Applies specification file to the model
+      Mavenlink::Specificators::Attribute.apply(model_class)
+      Mavenlink::Specificators::Association.apply(model_class)
+      Mavenlink::Specificators::Validation.apply(model_class)
+    end
+
+    # Returns all models registered in the app
+    # @return [Hash<String, Class>] key is collection name and value is a model assigned to this collection
+    def self.models
+      @models ||= ActiveSupport::HashWithIndifferentAccess.new
+    end
+
+    # Returns collection specification
+    # @return [Hash]
+    def self.specification
+      @specification ||= Mavenlink.specification[collection_name] || {}
+    end
+
+    # @todo REFACTOR NA
+    # @param association_name [String, Symbol]
+    def self.association(association_name)
+      define_method association_name do |reload = false|
+        return nil if new_record?
+
+        association = association_by_name(association_name)
+        reload = true unless association.loaded?
+
+        if reload
+          reload_association(association)
+          associations_cache[association_name] = fetch_association_records(association)
+        elsif associations_cache.has_key?(association_name)
+          associations_cache[association_name]
+        else
+          associations_cache[association_name] = fetch_association_records(association)
+        end
+      end
+    end
+
+    # @param names [String, Symbol]
+    def self.attribute(*names)
+      names.each do |name|
+        define_method(name) { self[name.to_s] }
+        define_method("#{name}=") { |value| self[name.to_s] = value }
+      end
+    end
+
+    # Returns list of available attributes
+    # @return [Array<String>]
+    def self.attributes
+      specification['attributes'] ||= []
+    end
+
+    # Returns list of all available attributes
+    # @return [Array<String>]
+    def self.available_attributes
+      create_attributes | update_attributes | attributes
+    end
+
+    # Returns the list of attributes available for new record
+    # @return [Array<String>]
+    def self.create_attributes
+      specification['create_attributes'] ||= []
+    end
+
+    # Returns the list of attributes available for update
+    # @return [Array<String>]
+    def self.update_attributes
+      specification['update_attributes'] ||= []
+    end
+
+    # @param source_record [Brainstem::Record, nil]
+    # @param client [Mavenlink::Client]
+    def self.wrap(source_record = nil, client = Mavenlink.client)
+      self.new({}, source_record, client)
+    end
+
+    # @param attributes [Hash]
+    # @param source_record [BrainstemAdaptor::Record]
+    # @param client [Mavenlink::Client]
+    def initialize(attributes = {}, source_record = nil, client = Mavenlink.client)
+      super(self.class.collection_name, (attributes[:id] || attributes['id'] || source_record.try(:id)), source_record.try(:response))
+      @client = client
+      merge!(attributes)
+    end
+
+    # @param attributes [Hash]
+    def attributes=(attributes)
+      merge!(attributes)
+    end
+
+    def persisted?
+      !!id
+    end
+
+    def new_record?
+      !persisted?
+    end
+
+    # @return [true, false]
+    def save
+      if valid?
+        reload(new_record? ? create : update)
+        true
+      else
+        false
+      end
+    end
+
+    # @raise [Mavenlink::RecordInvalidError]
+    # @return [true]
+    def save!
+      save or raise Mavenlink::RecordInvalidError.new(self)
+    end
+
+    # @param attributes [Hash]
+    # @return [true, false]
+    def update_attributes(attributes)
+      self.attributes = attributes
+      save
+    end
+
+    # @param attributes [Hash]
+    # @raise [Mavenlink::RecordInvalidError]
+    # @return [true]
+    def update_attributes!(attributes)
+      self.attributes = attributes
+      save!
+    end
+
+    # @note does not work, don't know what to do with removed record.
+    #  will just return RecordNotFound error if you call #save after #destroy
+    def destroy
+      request.delete
+    end
+    alias_method :delete, :destroy
+
+    # Reloads record from server
+    # @return [self]
+    def reload(response = nil)
+      response ||= request.find(id).try(:response) or raise RecordNotFoundError.new(request)
+      @id ||= response.results.first.try(:[], 'id')
+      load_fields_with(response)
+      self
+    end
+
+    # @overload
+    # @param context [:create, :update]
+    # @return [true, false]
+    def valid?(context = saving_context)
+      Mavenlink::Settings[:default][:perform_validations] ? super(context.try(:to_sym)) : true
+    end
+
+    # @return [String, nil]
+    def to_param
+      id.try(:to_s)
+    end
+
+    protected
+
+    # @return [Mavenlink::Response]
+    def create
+      request.create(attributes_for_create)
+    end
+
+    # @return [Mavenlink::Response]
+    def update
+      request.update(attributes_for_update)
+    end
+
+    # @return [Hash]
+    def attributes_for_create
+      specification_attributes('create_attributes')
+    end
+
+    # @return [Hash]
+    def attributes_for_update
+      specification_attributes('update_attributes')
+    end
+
+    # @return [Mavenlink::Request]
+    def request
+      collection_scope.only(id)
+    end
+
+    private
+
+    # Stores requested data in a Hash
+    # @return [Hash]
+    def associations_cache
+      @associations_cache ||= {}.with_indifferent_access
+    end
+
+    # @return [Mavenlink::Request]
+    def collection_scope
+      @collection_scope ||= self.class.scoped(client)
+    end
+
+    # @param association [BrainstemAdaptor::Association]
+    # @return [Array<Mavenlink::Model>, nil]
+    def fetch_association_records(association)
+      records = association.reflect
+
+      if records
+        wrapper = proc { |record| Mavenlink::Model.models[association.collection_name].wrap(record, client) }
+        records.kind_of?(BrainstemAdaptor::Association) ? records.map(&wrapper) : wrapper.call(records, client)
+      end
+    end
+
+    # @param association [BrainstemAdaptor::Association]
+    def reload_association(association)
+      response = request.include(association.name).find(id).try(:response) or raise RecordNotFoundError.new(request)
+      load_fields_with(response, [association.foreign_key])
+    end
+
+    def saving_context
+      new_record? ? :create : :update
+    end
+
+    # @param key [String]
+    # @return [Hash]
+    def specification_attributes(key)
+      {}.tap do |result|
+        self.to_hash.slice(*self.class.specification[key]).each do |attr_name, value|
+          result[attr_name] = value
+        end
+      end
+    end
+  end
+end

data/lib/mavenlink/organization.rb

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

data/lib/mavenlink/organization_membership.rb

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

data/lib/mavenlink/participation.rb

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

data/lib/mavenlink/post.rb

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

data/lib/mavenlink/project_template.rb

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

data/lib/mavenlink/project_template_assignment.rb

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