retentiongrid 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f20d8859d9e7bc3b343422102b0de9739236711
-  data.tar.gz: 618928f847d92e0d95c636617b54c601e1906d71
+  metadata.gz: 139d14d9aa302cb690c454fa2c470945ccd0a84e
+  data.tar.gz: 3bf5cef73bdc80f5e5cd1aacff0afd0d5a7939f4
 SHA512:
-  metadata.gz: c43e523cc8723253362faa2de50252d239e638e8ba6a008096350fe7209a3c93910b41b3c210a02f3a2de6413b79eb821ee17c185290a3b5061594652b1fa377
-  data.tar.gz: f6021a616226c2321555b282dcc1dedc9eff3b5179272cd7898a7b940b3910dfd87a197e1294aa5f6c358a72d8b77527f6e7e499fbb99129f8dec1cd2bb3dd20
+  metadata.gz: ffdf894f4a511a2f3e99545f4f0f4e258f2c92c2c8c8155ad951b13b4a970061a77472884c6b16db3aa45cd3a3e1f54d25b9d706a9a3569eb38966bf4e0ced3e
+  data.tar.gz: 7168575e837a34e38070fc8732032206991c98123b1bb137a09fea2fa7506750cdceaabd8ad1cb06b6a17e4614e88528c52648b1ddb34e07013363af7bcd0428

data/README.md

@@ -1,4 +1,4 @@
-# Retention::Grid
+# Retentiongrid
 
 [![Gem Version](https://fury-badge.herokuapp.com/rb/retentiongrid.png)](http://badge.fury.io/rb/retentiongrid)
 [![Build Status](https://travis-ci.org/christoph-buente/retentiongrid.png?branch=master)](https://travis-ci.org/christoph-buente/retentiongrid)
@@ -18,7 +18,7 @@ Add this line to your application's Gemfile:
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 

data/lib/retentiongrid.rb

@@ -1,5 +1,6 @@
 require 'active_model'
 require 'retentiongrid/version'
+require 'retentiongrid/resource'
 require 'retentiongrid/api'
 require 'retentiongrid/customer'
 require 'retentiongrid/errors'

data/lib/retentiongrid/customer.rb

@@ -8,9 +8,11 @@ module Retentiongrid
   # To get a order from the API:
   #   customer = Retentiongrid::Customer.find('C123')
   #
-  class Customer
+  class Customer < Resource
     include ActiveModel::Validations
 
+    BASE_PATH = '/customers'
+
     # The set of attributes defined by the API documentation
     ATTRIBUTES_NAMES = [ :customer_id, :full_name, :first_name, :email,
                          :country, :state, :city, :postal_code, :tags,
@@ -22,12 +24,6 @@ module Retentiongrid
 
     validates :customer_id, :full_name, presence: true
 
-    def initialize(attribs={})
-      attribs.each do |attrib, value|
-        self.send("#{attrib}=", value)
-      end
-    end
-
     # API Stuff here
 
     # Find a customer with given id
@@ -35,42 +31,26 @@ module Retentiongrid
     # @return [Customer] if found any
     def self.find(customer_id)
       begin
-        result = Api.get("/customers/#{customer_id}")
+        result = Api.get("#{BASE_PATH}/#{customer_id}")
         new(result.parsed_response["rg_customer"])
       rescue NotFound
         nil
       end
     end
 
-    # Create or update a customer with given id
-    # @return [Boolean] successfully created or updated?
-    def save
-      !!(save!) rescue false
-    end
-
     # Create or update a customer with given id
     # @return [Customer] if successfully created or updated
     # @raise [Httparty::Error] for all sorts of HTTP statuses.
     def save!
-      result = Api.post("/customers/#{customer_id}", body: attributes.to_json)
+      result = Api.post("#{BASE_PATH}/#{customer_id}", body: attributes.to_json)
       Customer.new(result.parsed_response["rg_customer"])
     end
 
     # Delete this customer at retention grid
     # @return [Boolean] successfully deleted?
     def destroy
-      Api.delete("/customers/#{customer_id}")
+      Api.delete("#{BASE_PATH}/#{customer_id}")
       true
     end
-
-    # Return all attributes as a hash
-    # @return [Hash]
-    def attributes
-      ATTRIBUTES_NAMES.inject({}) do |attribs, attrib_name|
-        value = self.send(attrib_name)
-        attribs[attrib_name] = value unless value.nil?
-        attribs
-      end
-    end
   end
 end

data/lib/retentiongrid/line_item.rb

@@ -1,5 +1,5 @@
 module Retentiongrid
-  class LineItem
+  class LineItem < Resource
 
     def initialize
       raise NotImplemented.new

data/lib/retentiongrid/order.rb

@@ -7,9 +7,11 @@ module Retentiongrid
   # To get a order from the API:
   #   order = Retentiongrid::Order.find('A123')
   #
-  class Order
+  class Order < Resource
     include ActiveModel::Validations
 
+    BASE_PATH = '/orders'
+
     # The set of attributes defined by the API documentation
     ATTRIBUTES_NAMES = [  :order_id, :customer_id, :status, :total_price, :total_discounts,
                           :currency, :canceled_shipped, :canceled_shop_fault, :order_created_at
@@ -24,9 +26,7 @@ module Retentiongrid
     validates :order_id, :customer_id, :currency, :total_price, :order_created_at, presence: true
 
     def initialize(attribs={})
-      attribs.each do |attrib, value|
-        self.send("#{attrib}=", value)
-      end
+      super
       @order_created_at = Time.parse(order_created_at) unless order_created_at.nil?
     end
 
@@ -44,42 +44,26 @@ module Retentiongrid
     # @return [Order] if found any
     def self.find(order_id)
       begin
-        result = Api.get("/orders/#{order_id}")
+        result = Api.get("#{BASE_PATH}/#{order_id}")
         new(result.parsed_response["rg_order"])
       rescue NotFound
         nil
       end
     end
 
-    # Create or update an order with given id
-    # @return [Boolean] successfully created or updated?
-    def save
-      !!(save!) rescue false
-    end
-
     # Create or update an order with given id
     # @return [Order] if successfully created or updated
     # @raise [Httparty::Error] for all sorts of HTTP statuses.
     def save!
-      result = Api.post("/orders/#{order_id}", { body: attributes.to_json })
+      result = Api.post("#{BASE_PATH}/#{order_id}", { body: attributes.to_json })
       Order.new(result.parsed_response["rg_order"])
     end
 
     # Delete this order at retention grid
     # @return [Boolean] successfully deleted?
     def destroy
-      Api.delete("/orders/#{order_id}")
+      Api.delete("#{BASE_PATH}/#{order_id}")
       true
     end
-
-    # Return all attributes as a hash
-    # @return [Hash]
-    def attributes
-      ATTRIBUTES_NAMES.inject({}) do |attribs, attrib_name|
-        value = self.send(attrib_name)
-        attribs[attrib_name] = value unless value.nil?
-        attribs
-      end
-    end
   end
 end

data/lib/retentiongrid/product.rb

@@ -1,8 +1,54 @@
 module Retentiongrid
-  class Product
+  class Product < Resource
 
-    def initialize
-      raise NotImplemented.new
+    BASE_PATH = '/products'
+
+    # The set of attributes defined by the API documentation
+    ATTRIBUTES_NAMES = [  :product_id, :available, :metadata,
+                          :title, :image_url, :currency, :price,
+                          :sale_price, :cost_price, :product_url,
+                          :product_created_at, :product_updated_at
+                       ].freeze
+
+    ATTRIBUTES_NAMES.each do |attrib|
+     attr_accessor attrib
+    end
+
+    def initialize(attribs={})
+      super
+      @product_created_at = Time.parse(product_created_at) unless product_created_at.nil?
+      @product_updated_at = Time.parse(product_updated_at) unless product_updated_at.nil?
     end
+
+
+    # API Stuff here
+
+    # Find a product with given id
+    # @param [Fixnum] product_id the prodct id to be found
+    # @return [Product] if found any
+    def self.find(product_id)
+      begin
+        result = Api.get("#{BASE_PATH}/#{product_id}")
+        new(result.parsed_response["rg_product"])
+      rescue NotFound
+        nil
+      end
+    end
+
+    # Create or update a product with given id
+    # @return [Product] if successfully created or updated
+    # @raise [Httparty::Error] for all sorts of HTTP statuses.
+    def save!
+      result = Api.post("#{BASE_PATH}/#{product_id}", body: attributes.to_json)
+      Product.new(result.parsed_response["rg_product"])
+    end
+
+    # Delete this product at retention grid
+    # @return [Boolean] successfully deleted?
+    def destroy
+      Api.delete("#{BASE_PATH}/#{product_id}")
+      true
+    end
+
   end
 end

data/lib/retentiongrid/resource.rb

@@ -0,0 +1,42 @@
+module Retentiongrid
+
+  # Retentiongrid Resource
+  # Base class for all API resources.
+  #
+  class Resource
+    include ActiveModel::Validations
+
+    ATTRIBUTES_NAMES = []
+
+    ATTRIBUTES_NAMES.each do |attrib|
+      attr_accessor attrib
+    end
+
+    def self.base_path
+      '/'
+    end
+
+    def initialize(attribs={})
+      attribs.each do |attrib, value|
+        self.send("#{attrib}=", value)
+      end
+    end
+
+    # Create or update a product with given id
+    # @return [Boolean] successfully created or updated?
+    def save
+      !!(save!) rescue false
+    end
+
+    # Return all attributes as a hash
+    # @return [Hash]
+    def attributes
+      ATTRIBUTES_NAMES.inject({}) do |attribs, attrib_name|
+        value = self.send(attrib_name)
+        attribs[attrib_name] = value unless value.nil?
+        attribs
+      end
+    end
+
+  end
+end

data/lib/retentiongrid/version.rb

@@ -1,3 +1,3 @@
 module Retentiongrid
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

data/spec/factories/products.rb

@@ -0,0 +1,19 @@
+FactoryGirl.define do
+
+  sequence :product_id do |n|
+    n
+  end
+
+  factory :product do
+    product_id
+    title "A fancy product"
+    currency 'EUR'
+    price 31.50
+    sale_price 30.00
+    cost_price 23.00
+    available true
+    image_url 'http://example.com/images/1.png'
+    product_updated_at { Time.now - 86400 }
+    product_created_at { Time.now - 161024 }
+  end
+end

data/spec/integration/product_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+include Retentiongrid
+RSpec.describe Product do
+
+  before do
+    WebMock.disable_net_connect!
+  end
+
+  def valid_order
+    <<-EOF
+    { "rg_product":
+      { "product_id": "123",
+        "product_created_at": "2014-03-11 13:35:10",
+        "available": true,
+        "metadata": "",
+        "product_updated_at": "2014-03-12 13:35:10",
+        "title": "An awesome product",
+        "image_url": "http://example.com/images/large.png",
+        "currency": "EUR",
+        "price": 169.00,
+        "sale_price": 169.00,
+        "cost_price": 99.00,
+        "product_url": "http://example.com/products/aweseome"
+      }
+    }
+    EOF
+  end
+
+  let(:api) { Api.new }
+
+  context '#find' do
+
+    subject do
+      stub_request(:get, "http://retentiongrid.apiary-mock.com/products/123").
+        to_return(:status => 200, :body => valid_order, :headers => {'Content-Type' => 'application/json'})
+      Product.find('123')
+    end
+
+    it "should build a Product from API response" do
+      expect(subject.class).to eql Retentiongrid::Product
+    end
+
+    it "should parse product_id correctly" do
+      expect(subject.product_id).to eql '123'
+    end
+
+    it "should parse available correctly" do
+      expect(subject.available).to eql true
+    end
+
+    it "should parse title correctly" do
+      expect(subject.title).to eql 'An awesome product'
+    end
+
+    it "should parse price correctly" do
+      expect(subject.price).to eql 169.0
+    end
+
+    it "should parse sale_price correctly" do
+      expect(subject.sale_price).to eql 169.0
+    end
+
+    it "should parse cost_price correctly" do
+      expect(subject.cost_price).to eql 99.0
+    end
+
+    it "should parse currency correctly" do
+      expect(subject.currency).to eql "EUR"
+    end
+
+    it "should parse product_created_at correctly" do
+      expect(subject.product_created_at).to eql Time.parse("2014-03-11 13:35:10")
+    end
+
+    it "should parse product_updated_at correctly" do
+      expect(subject.product_updated_at).to eql Time.parse("2014-03-12 13:35:10")
+    end
+
+  end
+
+  context '#create' do
+  end
+
+  context '#delete' do
+
+    let :product do
+      FactoryGirl.build(:product)
+    end
+
+    subject do
+      FactoryGirl.build(:product)
+    end
+
+    before :each do
+      stub_request(:delete, "http://retentiongrid.apiary-mock.com/products/#{subject.product_id}").to_return(:status => 204, :body => '')
+    end
+
+    it "should send delete to API" do
+      expect(subject.destroy).to eql true
+    end
+
+  end
+
+end

data/spec/models/customer_spec.rb

@@ -12,7 +12,7 @@ RSpec.describe Customer do
     it { expect(subject).to be_valid }
   end
 
-  it "makes sure the order id is populated" do
+  it "makes sure the customer id is populated" do
     expect(subject.customer_id).to_not eql nil
   end
 

data/spec/models/product_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+include Retentiongrid
+RSpec.describe Product do
+
+  subject do
+    FactoryGirl.build(:product)
+  end
+
+  it "makes sure the product id is populated" do
+    expect(subject.product_id).to_not eql nil
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: retentiongrid
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Christoph Bünte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-25 00:00:00.000000000 Z
+date: 2014-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -172,15 +172,19 @@ files:
 - lib/retentiongrid/line_item.rb
 - lib/retentiongrid/order.rb
 - lib/retentiongrid/product.rb
+- lib/retentiongrid/resource.rb
 - lib/retentiongrid/version.rb
 - log/.gitkeep
 - retentiongrid.gemspec
 - spec/factories/customers.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/order_spec.rb
+- spec/models/product_spec.rb
 - spec/spec_helper.rb
 homepage: http://retentiongrid.com/
 licenses:
@@ -209,9 +213,12 @@ summary: A ruby client for retentiongrid.com API.
 test_files:
 - spec/factories/customers.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/order_spec.rb
+- spec/models/product_spec.rb
 - spec/spec_helper.rb
 has_rdoc: