retentiongrid 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d0fa613d3babf6c177b1aac2f3ee7cd0fe7a1af
-  data.tar.gz: 625ee2cab1d11aacd52ba112ee8a206e1ffef971
+  metadata.gz: 892f3b7d7a66383fdfae7da935da621d00155b21
+  data.tar.gz: 1b5e1bc5ceb13d5357d1263afa3ce56d5e94bafe
 SHA512:
-  metadata.gz: 5aba78ecd284681abec3f5389656d0c4616f9e9d81475dc7212fd1a03998aa309640a789d7bfb969e3fe2ea66f295e77737f434364bd824c7fb172fd451b9e9f
-  data.tar.gz: 27025e4f718fc732c5467b8aef7d64d9fa4b6a89864cd072ba05c6a7b9c5c49db93a82e24ab4431217e013aca56c4262534c4f3d7a959205dc2703d7ff51f539
+  metadata.gz: 57dd691a5f50ee232404b6397ed985167f4e9ad1a8e393ce8fcd06bd536a46697457bdf98b71ceb545e0379eba40b6c525eb9c938f7fe4d106578871eafaa8aa
+  data.tar.gz: 5a65f1b4f48bd3be18375840aaf26dfd6050c690b01841d33a1ece176444aa1fcc2e5fce347f816449a769625515f95aaa4403824669b4da9de7a5bc3aa67ca3

data/README.md

@@ -26,10 +26,29 @@ Or install it yourself as:
 
 ## Usage
 
+### set you API key
+
     require 'retentiongrid'
     Retentiongrid::Api.api_key = "your_api_key"
+
+### Read from retentiongrid
+
     order = Retentiongrid::Order.find(1234)
 
+### Write to retentiongrid
+
+    order = Retentiongrid::Order.new({
+      status:           'ok',
+      order_id:         'R123',
+      customer_id:      'C321',
+      currency:         'EUR',
+      total_price:      35.99,
+      total_discounts:  0.0,
+      order_created_at: Time.now,
+    })
+    order.save
+
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/retentiongrid/fork )

data/lib/retentiongrid/line_item.rb

@@ -1,8 +1,56 @@
 module Retentiongrid
   class LineItem < Resource
 
-    def initialize
-      raise NotImplemented.new
+    BASE_PATH="/line_items".freeze
+
+    # The set of attributes defined by the API documentation
+    ATTRIBUTES_NAMES = [  :line_item_id, :order_id, :price, :quantity,
+                          :product_id, :variant_id, :sku, :name
+                       ].freeze
+
+    ATTRIBUTES_NAMES.each do |attrib|
+      attr_accessor attrib
+    end
+
+    def initialize(attribs={})
+      super
     end
+
+    # relations
+
+    def order=(order)
+      @order_id = order.order_id
+      @order = order
+    end
+
+    # API Stuff here
+
+    # Find a product with given id
+    # @param [Fixnum] product_id the prodct id to be found
+    # @return [LineItem] if found any
+    def self.find(line_item_id)
+      begin
+        result = Api.get("#{BASE_PATH}/#{line_item_id}")
+        new(result.parsed_response["rg_line_item"])
+      rescue NotFound
+        nil
+      end
+    end
+
+    # Create or update a line item with given id
+    # @return [LineItem] if successfully created or updated
+    # @raise [Httparty::Error] for all sorts of HTTP statuses.
+    def save!
+      result = Api.post("#{BASE_PATH}/#{line_item_id}", body: attributes.to_json)
+      new(result.parsed_response["rg_line_item"])
+    end
+
+    # Delete this line item at retention grid
+    # @return [Boolean] successfully deleted?
+    def destroy
+      Api.delete("#{BASE_PATH}/#{line_item_id}")
+      true
+    end
+
   end
 end

data/lib/retentiongrid/product.rb

@@ -7,7 +7,7 @@ module Retentiongrid
     ATTRIBUTES_NAMES = [  :product_id, :available, :metadata,
                           :title, :image_url, :currency, :price,
                           :sale_price, :cost_price, :product_url,
-                          :product_created_at, :product_updated_at
+                          :product_created_at, :product_updated_at, :meta
                        ].freeze
 
     ATTRIBUTES_NAMES.each do |attrib|

data/lib/retentiongrid/version.rb

@@ -1,3 +1,3 @@
 module Retentiongrid
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/spec/factories/line_items.rb

@@ -0,0 +1,14 @@
+FactoryGirl.define do
+
+  sequence :line_item_id do |n|
+    n
+  end
+
+  factory :line_item do
+    line_item_id
+    order
+    quantity 1
+    price 10.99
+    sku 'SDSD'
+  end
+end

data/spec/factories/products.rb

@@ -15,5 +15,11 @@ FactoryGirl.define do
     image_url 'http://example.com/images/1.png'
     product_updated_at { Time.now - 86400 }
     product_created_at { Time.now - 161024 }
+    meta { Hash.new(
+      type: "red",
+      region: "napa valley",
+      country: "USA",
+      varietal:  "pinot noir"
+    )}
   end
 end

data/spec/models/customer_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe Customer do
   end
 
   it "sets the base path correctly" do
-    expect(Customer::BASE_PATH).to eql '/customers'
+    expect(subject.class::BASE_PATH).to eql '/customers'
   end
 
   it "makes sure the customer id is populated" do

data/spec/models/line_item_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+include Retentiongrid
+RSpec.describe LineItem do
+
+  let :customer do
+    FactoryGirl.build(:customer)
+  end
+
+  let :order do
+    FactoryGirl.build(:order, customer: customer)
+  end
+
+  subject do
+    FactoryGirl.build(:line_item, order: order)
+  end
+
+  it "sets the base path correctly" do
+    expect(subject.class::BASE_PATH).to eql '/line_items'
+  end
+
+  it "makes sure the line item id is populated" do
+    expect(subject.line_item_id).to_not eql nil
+  end
+
+  context 'associations' do
+
+    it "sets up order association" do
+      expect(subject.order_id).to eql order.order_id
+    end
+  end
+
+end

data/spec/models/order_spec.rb

@@ -11,11 +11,19 @@ RSpec.describe Order do
   end
 
   it "sets the base path correctly" do
-    expect(Order::BASE_PATH).to eql '/orders'
+    expect(subject.class::BASE_PATH).to eql '/orders'
   end
 
   it "makes sure the order id is populated" do
     expect(subject.order_id).not_to eql nil
   end
 
+  context 'associations' do
+
+    it "sets up customer association" do
+      expect(subject.customer_id).to eql customer.customer_id
+    end
+  end
+
+
 end

data/spec/models/product_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe Product do
   end
 
   it "sets the base path correctly" do
-    expect(Product::BASE_PATH).to eql '/products'
+    expect(subject.class::BASE_PATH).to eql '/products'
   end
 
   it "makes sure the product id is populated" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: retentiongrid
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Christoph Bünte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-17 00:00:00.000000000 Z
+date: 2014-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -149,12 +149,14 @@ files:
 - log/.gitkeep
 - retentiongrid.gemspec
 - spec/factories/customers.rb
+- spec/factories/line_items.rb
 - spec/factories/orders.rb
 - spec/factories/products.rb
 - spec/integration/customer_spec.rb
 - spec/integration/order_spec.rb
 - spec/integration/product_spec.rb
 - spec/models/customer_spec.rb
+- spec/models/line_item_spec.rb
 - spec/models/order_spec.rb
 - spec/models/product_spec.rb
 - spec/spec_helper.rb
@@ -184,12 +186,14 @@ specification_version: 4
 summary: A ruby client for retentiongrid.com API.
 test_files:
 - spec/factories/customers.rb
+- spec/factories/line_items.rb
 - spec/factories/orders.rb
 - spec/factories/products.rb
 - spec/integration/customer_spec.rb
 - spec/integration/order_spec.rb
 - spec/integration/product_spec.rb
 - spec/models/customer_spec.rb
+- spec/models/line_item_spec.rb
 - spec/models/order_spec.rb
 - spec/models/product_spec.rb
 - spec/spec_helper.rb