basecrm 0.1.2 → 1.0.0

data/lib/basecrm/services/stages_service.rb

@@ -0,0 +1,52 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class StagesService
+    def initialize(client)
+      @client = client
+    end
+
+    # Retrieve all stages
+    # 
+    # get '/stages'
+    #
+    # If you want to use filtering or sorting (see #where).
+    # @return [Enumerable] Paginated resource you can use to iterate over all the resources. 
+    def all
+      PaginatedResource.new(self)
+    end
+
+    # Retrieve all stages
+    # 
+    # get '/stages'
+    #
+    # Returns all stages available to the user, according to the parameters provided
+    #
+    # @param options [Hash] Search options
+    # @option options [Boolean] :active Parameter that determines whether to return active or inactive stages. Unsupported for now.
+    # @option options [String] :ids Comma-separated list of stage IDs to be returned in a request.
+    # @option options [String] :name Name of the stage you're searching for. This parameter is used in a strict sense. Unsupported for now.
+    # @option options [Integer] :page (1) The page number to start from. Page numbering starts at 1, and omitting the `page` parameter will return the first page.
+    # @option options [Integer] :per_page (25) The number of records to return per page. The default limit is *25* and the maximum number that can be returned is *100*.
+    # @option options [Integer] :pipeline_id (1) The unique identifier of the pipeline that contains this stage.
+    # @option options [String] :sort_by (id:asc) Comma-separated list of fields to sort by. The sort criteria is applied in the order specified. The **default** ordering is **ascending**. If you want to change the sort ordering to descending, append `:desc` to the field e.g. `sort_by=position:desc`. Unsupported for now.
+    # @return [Array<Stage>] The list of Stages for the first page, unless otherwise specified. 
+    def where(options = {})
+      _, _, root = @client.get("/stages", options)
+
+      root[:items].map{ |item| Stage.new(item[:data]) }
+    end
+    
+
+  private
+    def validate_type!(stage)
+      raise TypeError unless stage.is_a?(Stage) || stage.is_a?(Hash)
+    end
+
+    def extract_params!(stage, *args)
+      params = stage.to_h.select{ |k, _| args.include?(k) }
+      raise ArgumentError, "one of required attributes is missing. Expected: #{args.join(',')}" if params.count != args.length
+      params
+    end
+  end
+end

data/lib/basecrm/services/tags_service.rb

@@ -0,0 +1,132 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class TagsService
+    OPTS_KEYS_TO_PERSIST = Set[:name, :resource_type]
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Retrieve all tags
+    # 
+    # get '/tags'
+    #
+    # If you want to use filtering or sorting (see #where).
+    # @return [Enumerable] Paginated resource you can use to iterate over all the resources. 
+    def all
+      PaginatedResource.new(self)
+    end
+
+    # Retrieve all tags
+    # 
+    # get '/tags'
+    #
+    # Returns all tags available to the user, according to the parameters provided
+    #
+    # @param options [Hash] Search options
+    # @option options [Integer] :creator_id User ID. Returns all tags created by that user.
+    # @option options [String] :ids Comma-separated list of deal tag IDs to be returned in a request.
+    # @option options [String] :name Name of the tag to search for. This parameter is used in a strict sense.
+    # @option options [Integer] :page (1) Page number to start from. Page numbering starts at 1, and omitting the `page` parameter will return the first page.
+    # @option options [Integer] :per_page (25) Number of records to return per page. The default limit is *25* and the maximum number that can be returned is *100*.
+    # @option options [String] :resource_type Type name of resource to search for.
+    # @option options [String] :sort_by (updated_at:asc) A field to sort by. The **default** order is **ascending**. If you want to change the sort order to descending, append `:desc` to the field e.g. `sort_by=name:desc`.
+    # @return [Array<Tag>] The list of Tags for the first page, unless otherwise specified. 
+    def where(options = {})
+      _, _, root = @client.get("/tags", options)
+
+      root[:items].map{ |item| Tag.new(item[:data]) }
+    end
+    
+
+    # Create a tag
+    # 
+    # post '/tags'
+    #
+    # Creates a new tag
+    # **Notice** the tag's name **must** be unique within the scope of the resource_type
+    #
+    # @param tag [Tag, Hash] Either object of the Tag type or Hash. This object's attributes describe the object to be created. 
+    # @return [Tag] The resulting object represting created resource. 
+    def create(tag)
+      validate_type!(tag)
+
+      attributes = sanitize(tag)
+      _, _, root = @client.post("/tags", attributes)
+
+      Tag.new(root[:data])
+    end
+    
+
+    # Retrieve a single tag
+    # 
+    # get '/tags/{id}'
+    #
+    # Returns a single tag available to the user according to the unique ID provided
+    # If the specified tag does not exist, this query will return an error
+    #
+    # @param id [Integer] Unique identifier of a Tag
+    # @return [Tag] Searched resource object. 
+    def find(id)
+      _, _, root = @client.get("/tags/#{id}")
+
+      Tag.new(root[:data])
+    end
+    
+
+    # Update a tag
+    # 
+    # put '/tags/{id}'
+    #
+    # Updates a tag's information
+    # If the specified tag does not exist, this query will return an error
+    # **Notice** if you want to update a tag, you **must** make sure the tag's name is unique within the scope of the specified resource
+    #
+    # @param tag [Tag, Hash] Either object of the Tag type or Hash. This object's attributes describe the object to be updated. 
+    # @return [Tag] The resulting object represting updated resource. 
+    def update(tag)
+      validate_type!(tag)
+      params = extract_params!(tag, :id)
+      id = params[:id]
+
+      attributes = sanitize(tag)
+      _, _, root = @client.put("/tags/#{id}", attributes)
+
+      Tag.new(root[:data])
+    end
+    
+
+    # Delete a tag
+    # 
+    # delete '/tags/{id}'
+    #
+    # Deletes an existing tag
+    # If the specified tag is assigned to any resource, we will remove this tag from all such resources
+    # If the specified tag does not exist, this query will return an error
+    # This operation cannot be undone
+    #
+    # @param id [Integer] Unique identifier of a Tag
+    # @return [Boolean] Status of the operation.
+    def destroy(id)
+      status, _, _ = @client.delete("/tags/#{id}")
+      status == 204
+    end
+    
+
+  private
+    def validate_type!(tag)
+      raise TypeError unless tag.is_a?(Tag) || tag.is_a?(Hash)
+    end
+
+    def extract_params!(tag, *args)
+      params = tag.to_h.select{ |k, _| args.include?(k) }
+      raise ArgumentError, "one of required attributes is missing. Expected: #{args.join(',')}" if params.count != args.length
+      params
+    end
+       
+    def sanitize(tag)
+      tag.to_h.select { |k, _| OPTS_KEYS_TO_PERSIST.include?(k) }
+    end
+  end
+end

data/lib/basecrm/services/tasks_service.rb

@@ -0,0 +1,141 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class TasksService
+    OPTS_KEYS_TO_PERSIST = Set[:completed, :content, :due_date, :owner_id, :remind_at, :resource_id, :resource_type]
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Retrieve all tasks
+    # 
+    # get '/tasks'
+    #
+    # If you want to use filtering or sorting (see #where).
+    # @return [Enumerable] Paginated resource you can use to iterate over all the resources. 
+    def all
+      PaginatedResource.new(self)
+    end
+
+    # Retrieve all tasks
+    # 
+    # get '/tasks'
+    #
+    # Returns all tasks available to the user, according to the parameters provided
+    # If you ask for tasks without any parameter provided Base API will return you both **floating** and **related** tasks
+    # Although you can narrow the search set to either of them via query parameters
+    #
+    # @param options [Hash] Search options
+    # @option options [Boolean] :completed Indicates whether the query will return tasks that are completed or not.
+    # @option options [Integer] :creator_id Unique identifier of the user. Returns all tasks created by the user.
+    # @option options [String] :ids Comma-separated list of task IDs to be returned in a request.
+    # @option options [Boolean] :overdue Indicates whether the query will return tasks where the `due_date` parameter has been passed or not.
+    # @option options [Integer] :owner_id Unique identifier of the user. Returns all tasks owned by the user.
+    # @option options [Integer] :page (1) Page number to start from. Page numbering starts at 1 and omitting the `page` parameter will return the first page.
+    # @option options [Integer] :per_page (25) Number of records to return per page. The default limit is *25* and the maximum number that can be returned is *100*.
+    # @option options [String] :q A query string to search for. Performs a full text search on the `content` field.
+    # @option options [Boolean] :remind Indicates whether the query will return tasks with reminders or without reminders.
+    # @option options [Integer] :resource_id Unique identifier of the resource that you're searching for.
+    # @option options [String] :resource_type Name of the resource type to search for.
+    # @option options [String] :sort_by (updated_at:asc) A field to sort by. The **default** ordering is **ascending**. If you want to change the sort order to descending, append `:desc` to the field e.g. `sort_by=resource_type:desc`.
+    # @option options [String] :type Type of tasks to search for.
+    # @return [Array<Task>] The list of Tasks for the first page, unless otherwise specified. 
+    def where(options = {})
+      _, _, root = @client.get("/tasks", options)
+
+      root[:items].map{ |item| Task.new(item[:data]) }
+    end
+    
+
+    # Create a task
+    # 
+    # post '/tasks'
+    #
+    # Creates a new task
+    # You can create either a **floating** task or create a **related** task and associate it with one of the resource types below:
+    # * [Leads](/docs/rest/reference/leads)
+    # * [Contacts](/docs/rest/reference/contacts)
+    # * [Deals](/docs/rest/reference/deals)
+    #
+    # @param task [Task, Hash] Either object of the Task type or Hash. This object's attributes describe the object to be created. 
+    # @return [Task] The resulting object represting created resource. 
+    def create(task)
+      validate_type!(task)
+
+      attributes = sanitize(task)
+      _, _, root = @client.post("/tasks", attributes)
+
+      Task.new(root[:data])
+    end
+    
+
+    # Retrieve a single task
+    # 
+    # get '/tasks/{id}'
+    #
+    # Returns a single task available to the user according to the unique task ID provided
+    # If the specified task does not exist, this query will return an error
+    #
+    # @param id [Integer] Unique identifier of a Task
+    # @return [Task] Searched resource object. 
+    def find(id)
+      _, _, root = @client.get("/tasks/#{id}")
+
+      Task.new(root[:data])
+    end
+    
+
+    # Update a task
+    # 
+    # put '/tasks/{id}'
+    #
+    # Updates task information
+    # If the specified task does not exist, this query will return an error
+    #
+    # @param task [Task, Hash] Either object of the Task type or Hash. This object's attributes describe the object to be updated. 
+    # @return [Task] The resulting object represting updated resource. 
+    def update(task)
+      validate_type!(task)
+      params = extract_params!(task, :id)
+      id = params[:id]
+
+      attributes = sanitize(task)
+      _, _, root = @client.put("/tasks/#{id}", attributes)
+
+      Task.new(root[:data])
+    end
+    
+
+    # Delete a task
+    # 
+    # delete '/tasks/{id}'
+    #
+    # Delete an existing task
+    # If the specified task does not exist, this query will return an error
+    # This operation cannot be undone
+    #
+    # @param id [Integer] Unique identifier of a Task
+    # @return [Boolean] Status of the operation.
+    def destroy(id)
+      status, _, _ = @client.delete("/tasks/#{id}")
+      status == 204
+    end
+    
+
+  private
+    def validate_type!(task)
+      raise TypeError unless task.is_a?(Task) || task.is_a?(Hash)
+    end
+
+    def extract_params!(task, *args)
+      params = task.to_h.select{ |k, _| args.include?(k) }
+      raise ArgumentError, "one of required attributes is missing. Expected: #{args.join(',')}" if params.count != args.length
+      params
+    end
+       
+    def sanitize(task)
+      task.to_h.select { |k, _| OPTS_KEYS_TO_PERSIST.include?(k) }
+    end
+  end
+end

data/lib/basecrm/services/users_service.rb

@@ -0,0 +1,83 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class UsersService
+    def initialize(client)
+      @client = client
+    end
+
+    # Retrieve all users
+    # 
+    # get '/users'
+    #
+    # If you want to use filtering or sorting (see #where).
+    # @return [Enumerable] Paginated resource you can use to iterate over all the resources. 
+    def all
+      PaginatedResource.new(self)
+    end
+
+    # Retrieve all users
+    # 
+    # get '/users'
+    #
+    # Returns all users, according to the parameters provided
+    #
+    # @param options [Hash] Search options
+    # @option options [Boolean] :confirmed Indicator whether to return only confirmed user accounts or not.
+    # @option options [String] :email Email of the user. This parameter is used in a strict sense.
+    # @option options [String] :ids Comma-separated list of user IDs to be returned in a request.
+    # @option options [String] :name Name of the user. This parameter is used in a strict sense.
+    # @option options [Integer] :page (1) Page number to start from. Page numbering starts at 1, and omitting the `page` parameter will return the first page.
+    # @option options [Integer] :per_page (25) Number of records to return per page. The default limit is *25*, and the maximum number that can be returned is *100*.
+    # @option options [String] :role Role of user to search for.
+    # @option options [String] :sort_by (id:asc) A field to sort by. The **default** order is **ascending**. If you want to change the sort order to descending, append `:desc` to the field e.g. `sort_by=name:desc`.
+    # @option options [String] :status Status of user accounts to search for.
+    # @return [Array<User>] The list of Users for the first page, unless otherwise specified. 
+    def where(options = {})
+      _, _, root = @client.get("/users", options)
+
+      root[:items].map{ |item| User.new(item[:data]) }
+    end
+    
+
+    # Retrieve a single user
+    # 
+    # get '/users/{id}'
+    #
+    # Returns a single user according to the unique user ID provided
+    # If the specified user does not exist, this query returns an error
+    #
+    # @param id [Integer] Unique identifier of a User
+    # @return [User] Searched resource object. 
+    def find(id)
+      _, _, root = @client.get("/users/#{id}")
+
+      User.new(root[:data])
+    end
+    
+  
+    # Retrieve an authenticating user
+    # 
+    # get '/users/self'
+    #
+    # Returns a single authenticating user, according to the authentication credentials provided
+    #
+    # @return [User] Resource object. 
+    def self
+      _, _, root = @client.get("/users/self")
+      User.new(root[:data])
+    end
+
+
+  private
+    def validate_type!(user)
+      raise TypeError unless user.is_a?(User) || user.is_a?(Hash)
+    end
+
+    def extract_params!(user, *args)
+      params = user.to_h.select{ |k, _| args.include?(k) }
+      raise ArgumentError, "one of required attributes is missing. Expected: #{args.join(',')}" if params.count != args.length
+      params
+    end
+  end
+end

data/lib/basecrm/version.rb

@@ -0,0 +1,3 @@
+module BaseCRM
+  VERSION = "1.0.0"
+end

data/spec/factories/associated_contact.rb

@@ -0,0 +1,14 @@
+FactoryGirl.define do
+  factory :associated_contact, class: BaseCRM::AssociatedContact do
+    # transient attributes, required in url
+    deal_id nil
+
+    role { "involved" }
+
+    contact_id {  contact.id }
+
+    to_create do |associated_contact|
+      client.associated_contacts.create(associated_contact.deal_id, associated_contact)
+    end
+  end
+end

data/spec/factories/contact.rb

@@ -0,0 +1,27 @@
+FactoryGirl.define do
+  factory :contact, class: BaseCRM::Contact do
+
+    description { "I know him via Tom" }
+    email { "mark@designservices.com" }
+    facebook { "mjohnson" }
+    fax { "+44-208-1234567" }
+    first_name { Faker::Name.first_name }
+    industry { "Design Services" }
+    is_organization { false }
+    last_name { Faker::Name.last_name }
+    linkedin { "mjohnson" }
+    mobile { "508-778-6516" }
+    name { Faker::Name.name }
+    phone { "508-778-6516" }
+    skype { "mjohnson" }
+    tags { ["important"] }
+    title { "CEO" }
+    twitter { "mjohnson" }
+    website { "www.designservices.com" }
+
+
+    to_create do |contact|
+      client.contacts.create(contact)
+    end
+  end
+end