basecrm 1.2.3 → 1.3.0

data/lib/basecrm/services/products_service.rb

@@ -0,0 +1,136 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class ProductsService
+    OPTS_KEYS_TO_PERSIST = Set[:name, :description, :sku, :active, :cost, :cost_currency, :prices, :max_discount, :max_markup]
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Retrieve all products
+    #
+    # get '/products'
+    #
+    # 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 products
+    #
+    # get '/products'
+    #
+    # Returns all products available to the user according to the parameters provided
+    #
+    # @param options [Hash] Search options
+    # @option options [String] :ids Comma-separated list of product IDs to be returned in a request.
+    # @option options [Integer] :organization_id Unique identifier of an organization.
+    # @option options [Integer] :owner_id Unique identifier of the user the product is owned by. Returns all products 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. Default limit is *25* and the maximum number that can be returned is *100*.
+    # @option options [String] :sort_by (id:asc) A field to sort by. **Default** ordering is **ascending**. If you want to change the sort ordering to descending, append `:desc` to the field e.g. `sort_by=value:desc`.
+    # @option options [String] :name Name of the product.
+    # @option options [String] :sku SKU of the product.
+    # @option options [Boolean] :active Indicator of whether or not the product is active.
+    # @return [Array<Product>] The list of Products for the first page, unless otherwise specified.
+    def where(options = {})
+      _, _, root = @client.get("/products", options)
+
+      root[:items].map{ |item| Product.new(item[:data]) }
+    end
+
+
+    # Create a product
+    #
+    # post '/products'
+    #
+    # Create a new product
+    #
+    # @param product [Product, Hash] Either object of the Product type or Hash. This object's attributes describe the object to be created.
+    # @return [Product] The resulting object represting created resource.
+    def create(product)
+      validate_type!(product)
+
+      attributes = sanitize(product)
+      _, _, root = @client.post("/products", attributes)
+
+      Product.new(root[:data])
+    end
+
+
+    # Retrieve a single product
+    #
+    # get '/products/{id}'
+    #
+    # Returns a single product, according to the unique product ID provided
+    # If the specified product does not exist, the request will return an error
+    #
+    # @param id [Integer] Unique identifier of a Product
+    # @return [Product] Searched resource object.
+    def find(id)
+      _, _, root = @client.get("/products/#{id}")
+
+      Product.new(root[:data])
+    end
+
+
+    # Update a product
+    #
+    # put '/products/{id}'
+    #
+    # Updates product information
+    # If the specified product does not exist, the request will return an error
+    # <figure class="notice"><p>In order to modify prices used on a record, you need to supply the entire set
+    # <code>prices</code> are replaced every time they are used in a request
+    # </p></figure>
+    #
+    # @param product [Product, Hash] Either object of the Product type or Hash. This object's attributes describe the object to be updated.
+    # @return [Product] The resulting object represting updated resource.
+    def update(product)
+      validate_type!(product)
+      params = extract_params!(product, :id)
+      id = params[:id]
+
+      attributes = sanitize(product)
+      _, _, root = @client.put("/products/#{id}", attributes)
+
+      Product.new(root[:data])
+    end
+
+
+    # Delete a product
+    #
+    # delete '/products/{id}'
+    #
+    # Delete an existing product from the catalog
+    # Existing orders and line items are not affected
+    # If the specified product does not exist, the request will return an error
+    # This operation cannot be undone
+    # Products can be removed only by an account administrator
+    #
+    # @param id [Integer] Unique identifier of a Product
+    # @return [Boolean] Status of the operation.
+    def destroy(id)
+      status, _, _ = @client.delete("/products/#{id}")
+      status == 204
+    end
+
+
+  private
+    def validate_type!(product)
+      raise TypeError unless product.is_a?(Product) || product.is_a?(Hash)
+    end
+
+    def extract_params!(product, *args)
+      params = product.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(product)
+      product.to_h.select { |k, _| OPTS_KEYS_TO_PERSIST.include?(k) }
+    end
+  end
+end

data/lib/basecrm/version.rb

@@ -1,3 +1,3 @@
 module BaseCRM
-  VERSION = "1.2.3"
+  VERSION = "1.3.0"
 end

data/spec/factories/deal_source.rb

@@ -0,0 +1,11 @@
+FactoryGirl.define do
+  factory :deal_source, class: BaseCRM::DealSource do
+
+    name { Faker::Name.name }
+
+
+    to_create do |deal_source|
+      client.deal_sources.create(deal_source)
+    end
+  end
+end

data/spec/factories/lead_source.rb

@@ -0,0 +1,11 @@
+FactoryGirl.define do
+  factory :lead_source, class: BaseCRM::LeadSource do
+
+    name { Faker::Name.name }
+
+
+    to_create do |lead_source|
+      client.lead_sources.create(lead_source)
+    end
+  end
+end

data/spec/factories/line_item.rb

@@ -0,0 +1,18 @@
+FactoryGirl.define do
+  factory :line_item, class: BaseCRM::LineItem do
+    # transient attributes, required in url
+    order_id nil
+
+    product_id { 5 }
+    value { 1599.99 }
+    variation { 0 }
+    currency { "USD" }
+    quantity { 1 }
+    price { 1599.99 }
+
+
+    to_create do |line_item|
+      client.line_items.create(line_item.order_id, line_item)
+    end
+  end
+end

data/spec/factories/order.rb

@@ -0,0 +1,12 @@
+FactoryGirl.define do
+  factory :order, class: BaseCRM::Order do
+
+    deal_id { 5 }
+    discount { 4 }
+
+
+    to_create do |order|
+      client.orders.create(order)
+    end
+  end
+end

data/spec/factories/product.rb

@@ -0,0 +1,19 @@
+FactoryGirl.define do
+  factory :product, class: BaseCRM::Product do
+
+    name { Faker::Name.name }
+    description { "Includes more storage options" }
+    sku { "enterprise-plan" }
+    active { true }
+    max_discount { 100 }
+    max_markup { 200 }
+    cost { 1599.99 }
+    cost_currency { "USD" }
+    prices { [{"amount"=>"1599.99", "currency"=>"USD"}, {"amount"=>"3599.99", "currency"=>"PLN"}] }
+
+
+    to_create do |product|
+      client.products.create(product)
+    end
+  end
+end

data/spec/services/deal_sources_service_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe BaseCRM::DealSourcesService do
+  describe 'Responds to' do
+    subject { client.deal_sources  }
+
+    it { should respond_to :all }
+    it { should respond_to :create }
+    it { should respond_to :destroy }
+    it { should respond_to :find }
+    it { should respond_to :update }
+    it { should respond_to :where }
+ 
+  end
+
+  describe :all do
+    it "returns a PaginatedResource" do
+      expect(client.deal_sources.all()).to be_instance_of BaseCRM::PaginatedResource
+    end
+  end
+
+  describe :where do
+    it "returns an array" do
+      expect(client.deal_sources.where(page: 1)).to be_an Array
+    end
+  end
+
+  describe :create do
+    it "returns instance of DealSource class" do
+      @deal_source = build(:deal_source)
+      expect(client.deal_sources.create(@deal_source)).to be_instance_of BaseCRM::DealSource
+    end
+  end
+
+  describe :find do
+    before :each do
+      @deal_source = create(:deal_source) 
+    end
+
+    it "returns an instance of DealSource class" do
+      expect(client.deal_sources.find(@deal_source.id)).to be_instance_of BaseCRM::DealSource
+    end
+  end
+
+  describe :update do
+    it "returns an updated instance of DealSource class" do
+      @deal_source = create(:deal_source)
+      expect(client.deal_sources.update(@deal_source)).to be_instance_of BaseCRM::DealSource
+    end
+  end
+
+  describe :destroy do
+    it "returns true on success" do
+      @deal_source = create(:deal_source)
+      expect(client.deal_sources.destroy(@deal_source.id)).to be_truthy
+    end
+  end
+end

data/spec/services/deals_service_spec.rb

@@ -10,7 +10,7 @@ describe BaseCRM::DealsService do
     it { should respond_to :find }
     it { should respond_to :update }
     it { should respond_to :where }
- 
+
   end
 
   describe :all do
@@ -39,7 +39,7 @@ describe BaseCRM::DealsService do
 
   describe :find do
     before :each do
-      @deal = create(:deal) 
+      @deal = create(:deal)
     end
 
     it "returns an instance of Deal class" do

data/spec/services/lead_sources_service_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe BaseCRM::LeadSourcesService do
+  describe 'Responds to' do
+    subject { client.lead_sources  }
+
+    it { should respond_to :all }
+    it { should respond_to :create }
+    it { should respond_to :destroy }
+    it { should respond_to :find }
+    it { should respond_to :update }
+    it { should respond_to :where }
+ 
+  end
+
+  describe :all do
+    it "returns a PaginatedResource" do
+      expect(client.lead_sources.all()).to be_instance_of BaseCRM::PaginatedResource
+    end
+  end
+
+  describe :where do
+    it "returns an array" do
+      expect(client.lead_sources.where(page: 1)).to be_an Array
+    end
+  end
+
+  describe :create do
+    it "returns instance of LeadSource class" do
+      @lead_source = build(:lead_source)
+      expect(client.lead_sources.create(@lead_source)).to be_instance_of BaseCRM::LeadSource
+    end
+  end
+
+  describe :find do
+    before :each do
+      @lead_source = create(:lead_source) 
+    end
+
+    it "returns an instance of LeadSource class" do
+      expect(client.lead_sources.find(@lead_source.id)).to be_instance_of BaseCRM::LeadSource
+    end
+  end
+
+  describe :update do
+    it "returns an updated instance of LeadSource class" do
+      @lead_source = create(:lead_source)
+      expect(client.lead_sources.update(@lead_source)).to be_instance_of BaseCRM::LeadSource
+    end
+  end
+
+  describe :destroy do
+    it "returns true on success" do
+      @lead_source = create(:lead_source)
+      expect(client.lead_sources.destroy(@lead_source.id)).to be_truthy
+    end
+  end
+end

data/spec/services/line_items_service_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe BaseCRM::LineItemsService do
+  before(:all) do
+    @product = create(:product)
+    @order = create_order
+  end
+  describe 'Responds to' do
+    subject { client.line_items  }
+
+    it { should respond_to :all }
+    it { should respond_to :create }
+    it { should respond_to :destroy }
+    it { should respond_to :find }
+    it { should respond_to :where }
+
+  end
+
+  describe :all do
+    it "returns a PaginatedResource" do
+      order_id = create_order.id
+      expect(client.line_items.all(order_id)).to be_instance_of BaseCRM::PaginatedResource
+    end
+  end
+
+  describe :where do
+    it "returns an array" do
+      order_id = create_order.id
+      expect(client.line_items.where(order_id, page: 1)).to be_an Array
+    end
+  end
+
+  describe :create do
+    it "returns instance of LineItem class" do
+      order_id = create_order.id
+      @line_item = build(:line_item, product_id: @product.id, order_id: @order.id)
+      expect(client.line_items.create(order_id, @line_item)).to be_instance_of BaseCRM::LineItem
+    end
+  end
+
+  describe :find do
+    before :each do
+      @line_item = create(:line_item, product_id: @product.id, order_id: @order.id)
+    end
+
+    it "returns an instance of LineItem class" do
+      expect(client.line_items.find(@order.id, @line_item.id)).to be_instance_of BaseCRM::LineItem
+    end
+  end
+
+  describe :destroy do
+    it "returns true on success" do
+      @line_item = create(:line_item, product_id: @product.id, order_id: @order.id)
+      expect(client.line_items.destroy(@order.id, @line_item.id)).to be_truthy
+    end
+  end
+
+  def create_order
+    deal = create(:deal)
+    create(:order, deal_id: deal.id)
+  end
+end

data/spec/services/orders_service_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe BaseCRM::OrdersService do
+  describe 'Responds to' do
+    subject { client.orders  }
+
+    it { should respond_to :all }
+    it { should respond_to :create }
+    it { should respond_to :destroy }
+    it { should respond_to :find }
+    it { should respond_to :update }
+    it { should respond_to :where }
+
+  end
+
+  describe :all do
+    it "returns a PaginatedResource" do
+      expect(client.orders.all()).to be_instance_of BaseCRM::PaginatedResource
+    end
+  end
+
+  describe :where do
+    it "returns an array" do
+      expect(client.orders.where(page: 1)).to be_an Array
+    end
+  end
+
+  describe :create do
+    it "returns instance of Order class" do
+      deal_id = create(:deal).id
+      @order = build(:order, deal_id: deal_id)
+      expect(client.orders.create(@order)).to be_instance_of BaseCRM::Order
+    end
+  end
+
+  describe :find do
+    before :each do
+      @order = create_order
+    end
+
+    it "returns an instance of Order class" do
+      expect(client.orders.find(@order.id)).to be_instance_of BaseCRM::Order
+    end
+  end
+
+  describe :update do
+    it "returns an updated instance of Order class" do
+      @order = create_order
+      expect(client.orders.update(@order)).to be_instance_of BaseCRM::Order
+    end
+  end
+
+  describe :destroy do
+    it "returns true on success" do
+      @order = create_order
+      expect(client.orders.destroy(@order.id)).to be_truthy
+    end
+  end
+
+  def create_order
+    deal = create(:deal)
+    create(:order, deal_id: deal.id)
+  end
+end