insightly2 0.1.4

data/lib/insightly2/dsl/task_categories.rb

@@ -0,0 +1,52 @@
+require 'insightly2/dsl'
+
+module Insightly2
+  module DSL::TaskCategories
+    # GET /v2.1/TaskCategories/{id}
+    # Get a task category.
+    # @param [String, Fixnum] id A task category's ID.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Insightly2::Resources::TaskCategory, nil].
+    def get_task_category(id:)
+      raise ArgumentError, "ID cannot be blank" if id.blank?
+      Resources::TaskCategory.parse(request(:get, "TaskCategories/#{id}"))
+    end
+
+    # GET /v2.1/TaskCategories
+    # Get a list of task categories.
+    # @return [Insightly2::Resources::TaskCategory, nil].
+    def get_task_categories
+      Resources::TaskCategory.parse(request(:get, "TaskCategories"))
+    end
+
+    # POST /v2.1/TaskCategories
+    # Creates a task category.
+    # @param [Hash] category The task category to create.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Insightly2::Resources::TaskCategory, nil].
+    def create_task_category(category:)
+      raise ArgumentError, "Category cannot be blank" if category.blank?
+      Resources::TaskCategory.parse(request(:post, "TaskCategories", category))
+    end
+
+    # PUT /v2.1/TaskCategories
+    # Updates a task category.
+    # @param [Hash] category The task category to update.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Insightly2::Resources::TaskCategory, nil].
+    def update_task_category(category:)
+      raise ArgumentError, "Category cannot be blank" if category.blank?
+      Resources::TaskCategory.parse(request(:put, "TaskCategories", category))
+    end
+
+    # DELETE /v2.1/TaskCategories/{id}
+    # Delete a task category.
+    # @param [String, Fixnum] id A task category's ID.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Faraday::Response].
+    def delete_task_category(id:)
+      raise ArgumentError, "ID cannot be blank" if id.blank?
+      request(:delete, "TaskCategories/#{id}")
+    end
+  end
+end

data/lib/insightly2/dsl/tasks.rb

@@ -0,0 +1,76 @@
+require 'insightly2/dsl'
+
+module Insightly2
+  module DSL::Tasks
+    # GET /v2.1/Tasks/{id}
+    # Get a task.
+    # @param [String, Fixnum] id A Task's ID.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Insightly2::Resources::Task, nil].
+    def get_task(id:)
+      raise ArgumentError, "ID cannot be blank" if id.blank?
+      Resources::Task.parse(request(:get, "Tasks/#{id}"))
+    end
+
+    # GET /v2.1/Tasks/{c_id}/Comments
+    # Get a list of comments for a task.
+    # @param [String, Fixnum] id A Task's ID.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Array, nil].
+    def get_task_comments(id:)
+      raise ArgumentError, "ID cannot be blank" if id.blank?
+      Resources::Comment.parse(request(:get, "Tasks/#{id}/Comments"))
+    end
+
+    # GET /v2.1/Tasks?ids={ids}
+    # Get a list of tasks.
+    # @param [ids:] Array of task ids (optional).
+    # @return [Insightly2::Resources::Task, nil].
+    def get_tasks(ids: [])
+      url = Utils::UrlHelper.build_url(path: "Tasks", params: {ids: ids.join(',')})
+      Resources::Task.parse(request(:get, url))
+    end
+
+    # POST /v2.1/Tasks
+    # Create a task.
+    # @param [Hash] task The task to create.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Insightly2::Resources::Task, nil].
+    def create_task(task:)
+      raise ArgumentError, "Task cannot be blank" if task.blank?
+      Resources::Task.parse(request(:post, "Tasks", task))
+    end
+
+    # POST /v2.1/Tasks/{c_id}/Comments
+    # Create a comment for a task.
+    # @param [String, Fixnum] id A task's ID.
+    # @param [Hash] comment The comment to create.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Insightly2::Resources::Comment, nil].
+    def create_task_comment(id:, comment:)
+      raise ArgumentError, "ID cannot be blank" if id.blank?
+      raise ArgumentError, "Comment cannot be blank" if comment.blank?
+      Resources::Comment.parse(request(:post, "Tasks/#{id}/Comments", comment))
+    end
+
+    # PUT /v2.1/Tasks
+    # Update a task.
+    # @param [Hash] task The task to update.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Insightly2::Resources::Comment, nil].
+    def update_task(task:)
+      raise ArgumentError, "Task cannot be blank" if task.blank?
+      Resources::Task.parse(request(:put, "Tasks", task))
+    end
+
+    # DELETE /v2.1/Tasks/{id}
+    # Delete a task.
+    # @param [String, Fixnum] id A Task's ID.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Faraday::Response].
+    def delete_task(id:)
+      raise ArgumentError, "ID cannot be blank" if id.blank?
+      request(:delete, "Tasks/#{id}")
+    end
+  end
+end

data/lib/insightly2/dsl/team_members.rb

@@ -0,0 +1,53 @@
+require 'insightly2/dsl'
+
+module Insightly2
+  module DSL::TeamMembers
+    # GET /v2.1/TeamMembers/{id}
+    # Get a team member.
+    # @param [String, Fixnum] id A team member's ID.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Insightly2::Resources::TeamMember, nil].
+    def get_team_member(id:)
+      raise ArgumentError, "ID cannot be blank" if id.blank?
+      Resources::TeamMember.parse(request(:get, "TeamMembers/#{id}"))
+    end
+
+    # GET /v2.1/TeamMembers?teamid={teamid}
+    # Get a list of team members.
+    # @param [String, Fixnum] team_id: The ID of the team we're getting members for (optional).
+    # @return [Array, nil]
+    def get_team_members(team_id:)
+      Resources::TeamMember.parse(request(:get, "TeamMembers/?teamid=#{team_id}"))
+    end
+
+    # POST /v2.1/TeamMembers
+    # Create a team member.
+    # @param [Hash] team_member The team_member we're creating.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Insightly2::Resources::TeamMember, nil].
+    def create_team_member(team_member:)
+      raise ArgumentError, "Team member cannot be blank" if team_member.blank?
+      Resources::TeamMember.parse(request(:post, "TeamMembers", team_member))
+    end
+
+    # PUT /v2.1/TeamMembers
+    # Update a team member.
+    # @param [Hash] team_member The team_member we're updating.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Insightly2::Resources::TeamMember, nil].
+    def update_team_member(team_member:)
+      raise ArgumentError, "Team member cannot be blank" if team_member.blank?
+      Resources::TeamMember.parse(request(:put, "TeamMembers", team_member))
+    end
+
+    # DELETE /v2.1/TeamMembers/{id}
+    # Delete a team member.
+    # @param [String, Fixnum] id A team member's ID.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Faraday::Response].
+    def delete_team_member(id:)
+      raise ArgumentError, "ID cannot be blank" if id.blank?
+      request(:delete, "TeamMembers/#{id}")
+    end
+  end
+end

data/lib/insightly2/dsl/teams.rb

@@ -0,0 +1,53 @@
+require 'insightly2/dsl'
+
+module Insightly2
+  # https://api.insight.ly/v2.1/Help/ApiController/Teams
+  module DSL::Teams
+    # GET /v2.1/Teams/{id}
+    # Get a team.
+    # @param [String, Fixnum] id A team's ID.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Insightly2::Resources::Team].
+    def get_team(id:)
+      raise ArgumentError, "ID cannot be blank" if id.blank?
+      Resources::Team.parse(request(:get, "Teams/#{id}"))
+    end
+
+    # GET /v2.1/Teams
+    # Get teams.
+    # @return [Array, nil].
+    def get_teams
+      Resources::Team.parse(request(:get, "Teams"))
+    end
+
+    # POST /v2.1/Teams
+    # Create a team.
+    # @param [Hash] team The team we're creating.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Insightly2::Resources::Team, nil].
+    def create_team(team:)
+      raise ArgumentError, "Team cannot be blank" if team.blank?
+      Resources::Team.parse(request(:post, "Teams", team))
+    end
+
+    # PUT /v2.1/Teams
+    # Update a team..
+    # @param [Hash] team The team we're updating.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Insightly2::Resources::Team, nil].
+    def update_team(team:)
+      raise ArgumentError, "Team cannot be blank" if team.blank?
+      Resources::Team.parse(request(:put, 'Teams', team))
+    end
+
+    # DELETE /v2.1/Teams/{id}
+    # Delete a team.
+    # @param [String, Fixnum] id A Team's ID.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Faraday::Response].
+    def delete_team(id:)
+      raise ArgumentError, "ID cannot be blank" if id.blank?
+      request(:delete, "Teams/#{id}")
+    end
+  end
+end

data/lib/insightly2/dsl/users.rb

@@ -0,0 +1,22 @@
+require 'insightly2/dsl'
+
+module Insightly2
+  module DSL::Users
+    # GET /v2.1/Users/{id}
+    # Get a user.
+    # @param [String, Fixnum] id A user's ID.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Insightly2::Resources::User, nil].
+    def get_user(id:)
+      raise ArgumentError, "ID cannot be blank" if id.blank?
+      Resources::User.parse(request(:get, "Users/#{id}"))
+    end
+
+    # GET /v2.1/Users
+    # Get a list of users.
+    # @return [Array, nil]
+    def get_users
+      Resources::User.parse(request(:get, "Users"))
+    end
+  end
+end

data/lib/insightly2/dsl.rb

@@ -0,0 +1,65 @@
+require 'insightly2'
+
+module Insightly2
+  module DSL
+  end
+end
+
+require 'insightly2/dsl/comments'
+require 'insightly2/dsl/contacts'
+require 'insightly2/dsl/countries'
+require 'insightly2/dsl/currencies'
+require 'insightly2/dsl/custom_fields'
+require 'insightly2/dsl/emails'
+require 'insightly2/dsl/events'
+require 'insightly2/dsl/file_attachments'
+require 'insightly2/dsl/file_categories'
+require 'insightly2/dsl/notes'
+require 'insightly2/dsl/opportunities'
+require 'insightly2/dsl/opportunity_categories'
+require 'insightly2/dsl/opportunity_state_reasons'
+require 'insightly2/dsl/organisations'
+require 'insightly2/dsl/pipeline_stages'
+require 'insightly2/dsl/pipelines'
+require 'insightly2/dsl/project_categories'
+require 'insightly2/dsl/projects'
+require 'insightly2/dsl/relationships'
+require 'insightly2/dsl/tags'
+require 'insightly2/dsl/task_categories'
+require 'insightly2/dsl/tasks'
+require 'insightly2/dsl/team_members'
+require 'insightly2/dsl/teams'
+require 'insightly2/dsl/users'
+require 'insightly2/utils'
+
+module Insightly2
+  module DSL
+    include Comments
+    include Contacts
+    include Countries
+    include Currencies
+    include CustomFields
+    include Emails
+    include Events
+    include FileAttachments
+    include FileCategories
+    include Notes
+    include Opportunities
+    include OpportunityCategories
+    include OpportunityStateReasons
+    include Organisations
+    include PipelineStages
+    include Pipelines
+    include ProjectCategories
+    include Projects
+    include Relationships
+    include Tags
+    include TaskCategories
+    include Tasks
+    include TeamMembers
+    include Teams
+    include Users
+    include Utils
+  end
+end
+

data/lib/insightly2/errors/client_error.rb

@@ -0,0 +1,10 @@
+module Insightly2
+  module Errors
+    class ClientError < StandardError
+      attr_reader :response
+      def initialize(response:)
+        @response = response
+      end
+    end
+  end
+end

data/lib/insightly2/errors/resource_not_found_error.rb

@@ -0,0 +1,8 @@
+require 'insightly2/errors/client_error'
+
+module Insightly2
+  module Errors
+    class ResourceNotFoundError < ClientError
+    end
+  end
+end

data/lib/insightly2/errors.rb

@@ -0,0 +1,10 @@
+require 'insightly2'
+
+module Insightly2
+  module Errors
+  end
+end
+
+require 'insightly2/errors/resource_not_found_error'
+require 'insightly2/errors/client_error'
+

data/lib/insightly2/resources/comment.rb

@@ -0,0 +1,10 @@
+require 'insightly2/resources/object'
+require 'insightly2/resources/file_attachment'
+
+module Insightly2
+  module Resources
+    class Comment < Insightly2::Resources::Object
+      has_many :file_attachments, FileAttachment
+    end
+  end
+end

data/lib/insightly2/resources/contact.rb

@@ -0,0 +1,8 @@
+require 'insightly2/resources/object'
+
+module Insightly2
+  module Resources
+    class Contact < Insightly2::Resources::Object
+    end
+  end
+end

data/lib/insightly2/resources/country.rb

@@ -0,0 +1,8 @@
+require 'insightly2/resources/object'
+
+module Insightly2
+  module Resources
+    class Country < Insightly2::Resources::Object
+    end
+  end
+end

data/lib/insightly2/resources/currency.rb

@@ -0,0 +1,8 @@
+require 'insightly2/resources/object'
+
+module Insightly2
+  module Resources
+    class Currency < Insightly2::Resources::Object
+    end
+  end
+end

data/lib/insightly2/resources/custom_field.rb

@@ -0,0 +1,8 @@
+require 'insightly2/resources/object'
+
+module Insightly2
+  module Resources
+    class CustomField < Insightly2::Resources::Object
+    end
+  end
+end

data/lib/insightly2/resources/email.rb

@@ -0,0 +1,8 @@
+require 'insightly2/resources/object'
+
+module Insightly2
+  module Resources
+    class Email < Insightly2::Resources::Object
+    end
+  end
+end

data/lib/insightly2/resources/event.rb

@@ -0,0 +1,8 @@
+require 'insightly2/resources/object'
+
+module Insightly2
+  module Resources
+    class Event < Insightly2::Resources::Object
+    end
+  end
+end

data/lib/insightly2/resources/file_attachment.rb

@@ -0,0 +1,8 @@
+require 'insightly2/resources/object'
+
+module Insightly2
+  module Resources
+    class FileAttachment < Insightly2::Resources::Object
+    end
+  end
+end

data/lib/insightly2/resources/file_category.rb

@@ -0,0 +1,8 @@
+require 'insightly2/resources/object'
+
+module Insightly2
+  module Resources
+    class FileCategory < Insightly2::Resources::Object
+    end
+  end
+end

data/lib/insightly2/resources/note.rb

@@ -0,0 +1,8 @@
+require 'insightly2/resources/object'
+
+module Insightly2
+  module Resources
+    class Note < Insightly2::Resources::Object
+    end
+  end
+end

data/lib/insightly2/resources/object/attributes.rb

@@ -0,0 +1,71 @@
+module Insightly2::Resources::Object::Attributes
+  module ClassMethods
+    def attributes
+      @attributes ||=
+        begin
+          if superclass.respond_to?(:attributes)
+            superclass.attributes.dup
+          else
+            Hash.new { |hash, key| hash[key] = ::Object }
+          end
+        end
+    end
+
+    # @return [Module] module holding all attribute accessors
+    def attributes_module
+      @attributes_module ||= const_set(:AttributeMethods, Module.new)
+    end
+
+    def define_attribute_accessor(name, type = nil)
+      type ||= attributes[name.to_sym] || Object
+      attributes_module.send(:define_method, name) do
+        deserialize_attribute(name, type)
+      end
+    end
+
+    def attribute(name, type = String)
+      attributes[name] = type
+
+      define_attribute_accessor(name, type)
+    end
+
+    alias_method :has_many, :attribute
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+    super
+  end
+
+  def attributes
+    {}.tap do |result|
+      __getobj__.keys.each do |key|
+        attribute = key.to_s.downcase
+        result[attribute] = public_send(attribute)
+      end
+    end
+  end
+
+  def method_missing(name, *args, &block)
+    attribute = name.to_s.upcase
+    if __getobj__.key?(attribute)
+      self.class.define_attribute_accessor(name)
+      deserialize_attribute(name, self.class.attributes[name.to_sym])
+    else
+      super
+    end
+  end
+
+  private
+
+  def respond_to_missing?(name, include_all = false)
+    __getobj__.key?(name.to_s.upcase) || super(name, include_all)
+  end
+
+  # @param [String, Symbol] name
+  # @param [Class, #to_s] type
+  def deserialize_attribute(name, type)
+    raw = __getobj__[name.to_s.upcase]
+    self.class.serializer_for(type).deserialize(raw)
+  end
+end

data/lib/insightly2/resources/object/serializers.rb

@@ -0,0 +1,102 @@
+require 'logger'
+module Insightly2
+  module Resources
+    class Object
+      module Serializers
+        module Object
+          def self.serialize(value)
+            value.to_s
+          end
+
+          def self.deserialize(value)
+            case value
+            when Array
+              value.map { |v| v.deep_transform_keys{ |key| key.downcase } }
+            when Hash
+              value.deep_transform_keys{ |key| key.downcase }
+            else
+              value
+            end
+          end
+        end
+
+        module Time
+          def self.serialize(value)
+            value.utc.xmlschema
+          end
+
+          def self.deserialize(value)
+            ::Time.parse(value)
+          end
+        end
+
+        module ClassMethods
+          # @return [Hash] corresponding serializers for different attributes
+          def serializers
+            @serializers ||= {}
+          end
+
+          # @param [String, Symbol] type type of attribute to be serialized or deserialized
+          # @return [#serialize, #deserialize] serializer for provided type
+          def serializer_for(type)
+            serializers[type] ||=
+              begin
+                class_symbol = type.to_s.to_sym
+                if type.respond_to?(:deserialize) && type.respond_to?(:serialize)
+                  type
+                elsif Serializers.constants.include?(class_symbol)
+                  Serializers.const_get(class_symbol)
+                elsif Resources.constants.include?(class_symbol)
+                  Resources.const_get(class_symbol)
+                else
+                  Serializers::Object
+                end
+              end
+          end
+
+          # Deserialize a Faraday response.
+          # @param [Faraday::Response] response.
+          # @raise [ArgumentError] If the response is blank.
+          # @return [Object, nil].
+          def deserialize(response)
+            raise ArgumentError, "Response cannot be blank" if response.blank?
+
+            attributes = response.body
+            begin
+              attributes = JSON.parse(response.body)
+              case attributes
+                when Array
+                  return attributes.map { |object| new(object) }
+                when Hash
+                  return new(attributes)
+              end
+            rescue JSON::ParserError
+              logger = Logger.new(STDOUT)
+              logger.error("Could not parse: #{response.body}")
+            end
+            nil
+          end
+
+          alias_method :parse, :deserialize
+
+          def serialize(object)
+            object.serialize
+          end
+        end
+
+        def self.included(base)
+          super
+          base.extend ClassMethods
+        end
+
+        def serialize
+          {}.tap do |result|
+            attributes.each do |name, value|
+              result[name.upcase] = self.class.serializer_for(name).serialize(value)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/insightly2/resources/object.rb

@@ -0,0 +1,29 @@
+require 'delegate'
+require 'json'
+require 'time'
+
+module Insightly2
+  module Resources
+    class Object < SimpleDelegator
+      require 'insightly2/resources/object/serializers'
+      require 'insightly2/resources/object/attributes'
+
+      include Serializers
+      include Attributes
+
+      # Define common attributes, applicable to different resources
+      attribute :date_created_utc, Time
+      attribute :date_updated_utc, Time
+
+      def inspect
+        "#<#{self.class.name}:#{'0x00%x' % (object_id << 1)} #{inspect_attributes}>"
+      end
+
+      private
+
+      def inspect_attributes
+        attributes.map { |key, value| "@#{key}=#{value.inspect}" }.join(' ')
+      end
+    end
+  end
+end

data/lib/insightly2/resources/opportunity.rb

@@ -0,0 +1,8 @@
+require 'insightly2/resources/object'
+
+module Insightly2
+  module Resources
+    class Opportunity < Insightly2::Resources::Object
+    end
+  end
+end

data/lib/insightly2/resources/opportunity_category.rb

@@ -0,0 +1,8 @@
+require 'insightly2/resources/object'
+
+module Insightly2
+  module Resources
+    class OpportunityCategory < Insightly2::Resources::Object
+    end
+  end
+end