mavenlink 0.0.1

data/lib/mavenlink/railtie.rb

@@ -0,0 +1,7 @@
+module Mavenlink
+  class Railtie < Rails::Railtie
+    initializer 'mavenlink.initialize' do
+      Mavenlink.oauth_token = ENV['MAVENLINK_OAUTH_TOKEN']
+    end
+  end
+end

data/lib/mavenlink/rate_card.rb

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

data/lib/mavenlink/rate_card_role.rb

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

data/lib/mavenlink/rate_card_set.rb

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

data/lib/mavenlink/rate_card_set_version.rb

@@ -0,0 +1,30 @@
+module Mavenlink
+  class RateCardSetVersion < Model
+    def publish
+      if persisted?
+        client.put("rate_card_set_versions/#@id/publish")
+        true
+      else
+        false
+      end
+    rescue Faraday::Error
+      false
+    end
+
+    def clone_version(effective_date = nil)
+      return false unless persisted?
+
+      request.perform do
+        client.post(collection_name, {
+          clone_id: self.id,
+          rate_card_set_version: {
+            rate_card_set_id: self.rate_card_set_id,
+            effective_date: effective_date
+          }
+        })
+      end.results.first
+    rescue Mavenlink::Error
+      false
+    end
+  end
+end

data/lib/mavenlink/rate_card_version.rb

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

data/lib/mavenlink/request.rb

@@ -0,0 +1,241 @@
+module Mavenlink
+  class Request
+    include Enumerable
+
+    attr_reader :client, :collection_name
+    attr_accessor :scope
+
+    # @param collection_name [String, Symbol]
+    # @param client [Mavenlink::Client]
+    def initialize(collection_name, client = Mavenlink.client)
+      @collection_name = collection_name
+      @client = client
+      @scope = ActiveSupport::HashWithIndifferentAccess.new
+    end
+
+    # Returns new chained request
+    # @param new_scope [Hash]
+    # @return [Mavenlink::Request]
+    def chain(new_scope = {})
+      self.class.new(collection_name, client).tap do |new_request|
+        new_request.scope.merge!(scope)
+        new_request.scope.merge!(new_scope)
+      end
+    end
+
+    # @param ids [String, Array]
+    # @return [Mavenlink::Request]
+    def only(*ids)
+      if ids.try(:flatten).present?
+        chain(only: param_to_request_array(ids))
+      else
+        without(:only)
+      end
+    end
+
+    # @param id [Integer, String]
+    # @return [BrainstemAdaptor::Record, nil]
+    def find(id)
+      only(id).perform.results.first
+    end
+
+    # @param text [String]
+    # @return [Mavenlink::Request]
+    def search(text)
+      chain(search: text)
+    end
+
+    # @param options [Hash]
+    def filter(options)
+      chain(options)
+    end
+
+    # @param associations [String, Array]
+    # @return [Mavenlink::Request]
+    def includes(*associations)
+      chain(include: param_to_request_array(associations))
+    end
+    alias_method :include, :includes
+
+    # @param [Integer, String]
+    # @return [Mavenlink::Request]
+    def page(number)
+      chain(page: number)
+    end
+
+    def current_page
+      @scope[:page].try(:to_i) || 1
+    end
+
+    # @return [Integer]
+    def total_count
+      response.total_count
+    end
+
+    # Kaminari support
+    # @return [Integer]
+    def total_pages
+      (total_count / (@scope[:per_page].try(:to_f) || 200.0)).ceil
+    end
+
+    # Kaminari support
+    # @return [Integer]
+    def limit_value
+      @scope[:limit].try(:to_i) || total_count
+    end
+
+    # @param [Integer, String]
+    # @return [Mavenlink::Request]
+    def per_page(number)
+      chain(per_page: number)
+    end
+
+    # @param [Integer, String]
+    # @return [Mavenlink::Request]
+    def limit(number)
+      chain(limit: number)
+    end
+
+    # @param [Integer, String]
+    # @return [Mavenlink::Request]
+    def offset(number)
+      chain(offset: number)
+    end
+
+    # Removes condition from the scope
+    # @param key [String, Symbol]
+    # @return [Mavenlink::Request] new request
+    def without(key)
+      chain.tap { |new_scope| new_scope.scope.delete(key) }
+    end
+
+    # @param field [String, Symbol]
+    # @param direction_or_desc [String, nil, true, false]
+    # @example
+    #  workspaces.order(:created_at)
+    #  workspaces.order(:created_at, :desc)
+    #  workspaces.order(:created_at, :asc)
+    #  workspaces.order(:created_at, 'DESC')
+    #  workspaces.order('created_at:desc')
+    # @return [Mavenlink::Request]
+    def order(field, direction_or_desc = nil)
+      case direction_or_desc
+      when :desc, 'DESC', 'desc', true
+        field = "#{field}:desc"
+      when :asc, nil, 'ASC', 'asc', false
+      else
+        raise ArgumentError, "Invalid request ordering set '#{direction_or_desc}'"
+      end
+
+      chain(order: field.to_s)
+    end
+
+    # @param attributes [Hash]
+    # @return [Mavenlink::Model]
+    def build(attributes)
+      "Mavenlink::#{collection_name.classify}".constantize.new(attributes, nil, client)
+    end
+
+    # @param attributes [Hash]
+    # @return [Mavenlink::Response]
+    def create(attributes)
+      perform { client.post(collection_name, {collection_name.singularize => attributes}) }
+    end
+
+    # @param attributes [Hash]
+    # @return [Mavenlink::Response]
+    def update(attributes)
+      perform { client.put(resource_path, {collection_name.singularize => attributes}) }
+    end
+
+    # @note Weird non-json response?
+    # @return [nil]
+    def delete
+      client.delete(resource_path)
+    end
+
+    # @return [Mavenlink::Response]
+    def perform
+      response = block_given? ? yield : client.get(collection_name, scope)
+      Mavenlink::Response.new(response, client)
+    end
+
+    # Returns cached response
+    # @return [Mavenlink::Response]
+    def response
+      @response ||= perform
+    end
+
+    def results
+      @results ||= response.results
+    end
+    alias_method :all, :results
+
+    def reload
+      @results = nil
+      results
+    end
+
+    def each(&block)
+      results.each(&block)
+    end
+
+    # Iterates through each page, similar to ActiveRecord's #find_in_batches.
+    # @todo replace with lazy enumerator for ruby 2.0
+    # @param batch_size [Integer]
+    # @return [Enumerator<Array<Mavenlink::Model>>]
+    def each_page(batch_size = 200, &block)
+      Enumerator.new do |result|
+        i = 0
+        records_passed = 0
+        request = per_page(batch_size)
+        page_records = []
+        total_count = Float::INFINITY
+
+        while (records_passed += page_records.count) < total_count
+          response = request.page(i+=1).perform
+          total_count = response.total_count
+          result << page_records = response.results
+        end
+      end.each(&block)
+    end
+
+    def scoped
+      self
+    end
+
+    def to_hash
+      scope
+    end
+
+    # @see https://github.com/rails/rails/blob/682d7c7035fed76c42ba6fefa38973387e80409e/activerecord/lib/active_record/relation.rb#L572
+    # @return [String]
+    def inspect
+      entries = to_a.map { |e| "<#{e.class.name}:#{e['id']}>" }
+      "#<#{self.class.name} [#{entries.join(', ')}]>"
+    end
+
+    # Returns "show" path for the resource
+    # @raise [ArgumentError] when ID is not included in criteria
+    # @return [String]
+    def resource_path
+      id = @scope[:only] or raise ArgumentError, 'No route matches source path without an ID'
+      "#{collection_name}/#{id}"
+    end
+
+    private
+
+    # Builds comma-separated query param
+    # @param param [Array, String]
+    def param_to_request_array(param)
+      case param
+      when Array
+        param.join(',').gsub(/\s+/, '')
+      when String, Symbol
+        param.to_s.gsub(/\s+/, '')
+      else
+        raise ArgumentError, "Expected Array, got #{param.class.name}"
+      end
+    end
+  end
+end

data/lib/mavenlink/resolution.rb

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

data/lib/mavenlink/response.rb

@@ -0,0 +1,22 @@
+module Mavenlink
+  class Response < BrainstemAdaptor::Response
+
+    attr_reader :client
+
+    # @param response_data [String, Hash]
+    # @param specification [BrainstemAdaptor::Specification]
+    # @param client [Mavenlink::Client]
+    def initialize(response_data, client = Mavenlink.client, specification = Mavenlink.specification)
+      @client = client
+      super(response_data, specification)
+    end
+
+    # Returns collection records
+    # Wraps brainstem records into mavenlink models
+    # @override
+    # @return [Array<MavenLink::Model>]
+    def results
+      super.map { |record| Mavenlink::Model.models[record.collection_name].wrap(record, client) }
+    end
+  end
+end

data/lib/mavenlink/role.rb

@@ -0,0 +1,5 @@
+module Mavenlink
+  class Role < Model
+    validates :name, presence: true
+  end
+end

data/lib/mavenlink/settings.rb

@@ -0,0 +1,11 @@
+module Mavenlink
+  class Settings < ActiveSupport::HashWithIndifferentAccess
+    DEFAULTS = {perform_validations: false}.freeze
+
+    def self.[](key)
+      (@instances ||= {})[key] ||= self.new.tap do |defaults|
+        defaults.merge!(DEFAULTS)
+      end
+    end
+  end
+end

data/lib/mavenlink/skill.rb

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

data/lib/mavenlink/skill_category.rb

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

data/lib/mavenlink/skill_membership.rb

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

data/lib/mavenlink/specificators/association.rb

@@ -0,0 +1,13 @@
+module Mavenlink
+  module Specificators
+    class Association < Base
+
+      # Defines attributes in model described in specification
+      def apply
+        (model_class.specification['associations'] || {}).keys.each do |association_name|
+          model_class.association association_name
+        end
+      end
+    end
+  end
+end

data/lib/mavenlink/specificators/attribute.rb

@@ -0,0 +1,13 @@
+module Mavenlink
+  module Specificators
+    class Attribute < Base
+
+      # Defines attributes in model described in specification
+      def apply
+        (model_class.available_attributes).each do |attr|
+          model_class.attribute attr
+        end
+      end
+    end
+  end
+end

data/lib/mavenlink/specificators/base.rb

@@ -0,0 +1,24 @@
+module Mavenlink
+  module Specificators
+
+    # Specificator is used to inject anything described in specification file into your model.
+    class Base
+      attr_reader :model_class
+
+      # @param model_class [Class]
+      def initialize(model_class)
+        @model_class = model_class
+      end
+
+      # Injects things described in specification file into the model
+      def apply
+        raise NotImplementedError
+      end
+
+      # @param model_class [Class]
+      def self.apply(model_class)
+        self.new(model_class).apply
+      end
+    end
+  end
+end

data/lib/mavenlink/specificators/validation.rb

@@ -0,0 +1,27 @@
+module Mavenlink
+  module Specificators
+    class Validation < Base
+
+      # Defines attributes in model described in specification
+      def apply
+        (model_class.specification['validations'] || {}).each do |fields, options|
+          model_class.validates(*fields, to_validation_options(options))
+        end
+      end
+
+      private
+
+      # Returns hash for validation options
+      # @param options [Hash]
+      # @return [Hash]
+      def to_validation_options(options)
+        options.tap do
+          if options.is_a?(Hash)
+            options.symbolize_keys!
+            options.keys.each { |key| to_validation_options(options[key]) }
+          end
+        end
+      end
+    end
+  end
+end