retentiongrid 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc982fceff738bbdc926a70180a7fcac16e2837e
-  data.tar.gz: c46f09b43f55724b4aa9fa3313d8e3ef66728b5d
+  metadata.gz: 6f20d8859d9e7bc3b343422102b0de9739236711
+  data.tar.gz: 618928f847d92e0d95c636617b54c601e1906d71
 SHA512:
-  metadata.gz: dadd35f11ccd9fdd5a1f0fe5187bdff5adaa063b970f65594dc97e71af462e8c55aeef26d97d13eb160607847399445d4dcef538fa63b4e0bb87b1e3499ea065
-  data.tar.gz: 9c089755a448ee50a36249a4a7bd864b0663c20f02053bfe9ae60f2dc9af1adb82f2ba46f0e6eab6599df8c0f721b53f0c23eb58b6bc64bf6028216edde30bee
+  metadata.gz: c43e523cc8723253362faa2de50252d239e638e8ba6a008096350fe7209a3c93910b41b3c210a02f3a2de6413b79eb821ee17c185290a3b5061594652b1fa377
+  data.tar.gz: f6021a616226c2321555b282dcc1dedc9eff3b5179272cd7898a7b940b3910dfd87a197e1294aa5f6c358a72d8b77527f6e7e499fbb99129f8dec1cd2bb3dd20

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+
+notifications:
+  email:
+    - info@christophbuente.de

data/README.md

@@ -1,7 +1,15 @@
 # Retention::Grid
 
+[![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)
+[![Coverage Status](https://coveralls.io/repos/christoph-buente/retentiongrid/badge.png)](https://coveralls.io/r/christoph-buente/retentiongrid)
+[![Code Climate](https://codeclimate.com/github/christoph-buente/retentiongrid.png)](https://codeclimate.com/github/christoph-buente/retentiongrid)
+[![License](http://img.shields.io/license/MIT.png?color=green) ](https://github.com/christoph-buente/retentiongrid/blob/master/LICENSE)
+
+
 A ruby client for retentiongrid.com API
 
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/retentiongrid/api.rb

@@ -4,10 +4,6 @@ module Retentiongrid
 
   # The Api class handles all calls to the Retentiongrid API.
   #
-  # Usage:
-  #   require 'retentiongrid'
-  #   Retentiongrid::Api.api_key = "your_api_key"
-  #   order = Retentiongrid::Order.find(1234)
   class Api
     include HTTParty
 
@@ -22,20 +18,48 @@ module Retentiongrid
 
     class << self
 
+      # Set your API key to communicate with retentiongrid
+      # @param [String] api_key your API key,
       def api_key=(api_key)
         default_params token: api_key
       end
 
+      # Do a HTTP GET requests with the given arguments
+      # and then check for the response code.
+      # @raise [Retentiongrid::BadRequest] (400) in case the request was not legible to the server
+      # @raise [Retentiongrid::Forbidden] (403) access denied (e.g. wrong api key)
+      # @raise [Retentiongrid::NotFound] (404) in case the requested resource could not be found
+      # @raise [Retentiongrid::ServerError] (500) in case something went wrong on the retentiongrid server
+      # @return [Httparty::Response]
       def get_with_response_check(*args)
         check_response_codes(get_without_response_check(*args))
       end
       alias_method_chain :get, :response_check
 
+      # Do a HTTP POST requests with the given arguments
+      # and then check for the response code.
+      # @raise [Retentiongrid::BadRequest] (400) in case the request was not legible to the server
+      # @raise [Retentiongrid::Forbidden] (403) access denied (e.g. wrong api key)
+      # @raise [Retentiongrid::NotFound] (404) in case the requested resource could not be found
+      # @raise [Retentiongrid::ServerError] (500) in case something went wrong on the retentiongrid server
+      # @return [Httparty::Response]
       def post_with_response_check(*args)
         check_response_codes(post_without_response_check(*args))
       end
       alias_method_chain :post, :response_check
 
+      # Do a HTTP DELETE requests with the given arguments
+      # and then check for the response code.
+      # @raise [Retentiongrid::BadRequest] (400) in case the request was not legible to the server
+      # @raise [Retentiongrid::Forbidden] (403) access denied (e.g. wrong api key)
+      # @raise [Retentiongrid::NotFound] (404) in case the requested resource could not be found
+      # @raise [Retentiongrid::ServerError] (500) in case something went wrong on the retentiongrid server
+      # @return [Httparty::Response]
+      def delete_with_response_check(*args)
+        check_response_codes(delete_without_response_check(*args))
+      end
+      alias_method_chain :delete, :response_check
+
     end
 
     private

data/lib/retentiongrid/customer.rb

@@ -1,7 +1,17 @@
 module Retentiongrid
+
+  # Retentiongrid Customer
+  #
+  # To create a new Retentiongrid::Customer object:
+  #   customer = Retentiongrid::Customer.new(customer_id: 'C123', full_name: 'Chris Tucker').save
+  #
+  # To get a order from the API:
+  #   customer = Retentiongrid::Customer.find('C123')
+  #
   class Customer
     include ActiveModel::Validations
 
+    # The set of attributes defined by the API documentation
     ATTRIBUTES_NAMES = [ :customer_id, :full_name, :first_name, :email,
                          :country, :state, :city, :postal_code, :tags,
                          :accepts_email_marketing ].freeze
@@ -32,21 +42,29 @@ module Retentiongrid
       end
     end
 
-
-
+    # Create or update a customer with given id
+    # @return [Boolean] successfully created or updated?
     def save
-      result = Api.post("/customers/#{customer_id}", body: attributes.to_json)
-      Customer.new(result.parsed_response["rg_customer"])
+      !!(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!
-      !!save
+      result = Api.post("/customers/#{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
-      res = Api.delete("/customers/#{customer_id}")
+      Api.delete("/customers/#{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)
@@ -54,6 +72,5 @@ module Retentiongrid
         attribs
       end
     end
-
   end
 end

data/lib/retentiongrid/line_item.rb

@@ -0,0 +1,8 @@
+module Retentiongrid
+  class LineItem
+
+    def initialize
+      raise NotImplemented.new
+    end
+  end
+end

data/lib/retentiongrid/order.rb

@@ -2,14 +2,15 @@ module Retentiongrid
   # Retentiongrid Order
   #
   # To create a new Retentiongrid::Order object:
-  #   order = Retention::Order.new(:id => "123", :lat => "52.2", :lon => "13.4", :changeset => "12", :user => "fred", :uid => "123", :visible => true, :timestamp => "2005-07-30T14:27:12+01:00")
+  #   order = Retentiongrid::Order.new(order_id: "A123", customer_id: 'C123', currency: 'EUR', total_price: 12.00, order_created_at: Time.now).save
   #
   # To get a order from the API:
-  #   order = Retention::Order.find(17)
+  #   order = Retentiongrid::Order.find('A123')
   #
   class Order
     include ActiveModel::Validations
 
+    # 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
                        ].freeze
@@ -29,7 +30,6 @@ module Retentiongrid
       @order_created_at = Time.parse(order_created_at) unless order_created_at.nil?
     end
 
-
     # relations
 
     def customer=(customer)
@@ -51,16 +51,29 @@ module Retentiongrid
       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 })
-      puts result.inspect
       Order.new(result.parsed_response["rg_order"])
     end
 
+    # Delete this order at retention grid
+    # @return [Boolean] successfully deleted?
     def destroy
-      res = Api.delete("/orders/#{order_id}")
+      Api.delete("/orders/#{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)
@@ -68,6 +81,5 @@ module Retentiongrid
         attribs
       end
     end
-
   end
 end

data/lib/retentiongrid/product.rb

@@ -0,0 +1,8 @@
+module Retentiongrid
+  class Product
+
+    def initialize
+      raise NotImplemented.new
+    end
+  end
+end

data/lib/retentiongrid/version.rb

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

data/lib/retentiongrid.rb

@@ -3,7 +3,9 @@ require 'retentiongrid/version'
 require 'retentiongrid/api'
 require 'retentiongrid/customer'
 require 'retentiongrid/errors'
+require 'retentiongrid/line_item'
 require 'retentiongrid/order'
+require 'retentiongrid/product'
 
 module Retentiongrid
 end

data/retentiongrid.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Christoph Bünte"]
   spec.email         = ["info@christophbuente.de"]
   spec.summary       = "A ruby client for retentiongrid.com API."
-  spec.homepage      = "https://github.com/christoph-buente/retentiongrid"
+  spec.homepage      = "http://retentiongrid.com/"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -30,4 +30,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'webmock'
   spec.add_development_dependency 'factory_girl'
 
+  spec.add_development_dependency 'coveralls'
+
 end

data/spec/integration/customer_spec.rb

@@ -48,6 +48,18 @@ RSpec.describe Customer do
   end
 
   context '#delete' do
+
+    subject do
+      FactoryGirl.build(:customer)
+    end
+
+    before :each do
+      stub_request(:delete, "http://retentiongrid.apiary-mock.com/customers/#{subject.customer_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/integration/order_spec.rb

@@ -79,6 +79,23 @@ RSpec.describe Order do
   end
 
   context '#delete' do
+
+    let :customer do
+      FactoryGirl.build(:customer)
+    end
+
+    subject do
+      FactoryGirl.build(:order, customer: customer)
+    end
+
+    before :each do
+      stub_request(:delete, "http://retentiongrid.apiary-mock.com/orders/#{subject.order_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

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

data/spec/models/order_spec.rb

@@ -20,7 +20,7 @@ RSpec.describe Order do
   end
 
   it "makes sure the order id is populated" do
-    expect(subject.order_id).to eql 1
+    expect(subject.order_id).not_to eql nil
   end
 
 end

data/spec/spec_helper.rb

@@ -4,6 +4,8 @@ require 'retentiongrid'
 require 'shoulda/matchers'
 
 require 'rspec'
+require 'coveralls'
+Coveralls.wear!
 
 RSpec.configure do |config|
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: retentiongrid
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Christoph Bünte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-18 00:00:00.000000000 Z
+date: 2014-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - info@christophbuente.de
@@ -145,6 +159,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - LICENSE.txt
@@ -154,7 +169,9 @@ files:
 - lib/retentiongrid/api.rb
 - lib/retentiongrid/customer.rb
 - lib/retentiongrid/errors.rb
+- lib/retentiongrid/line_item.rb
 - lib/retentiongrid/order.rb
+- lib/retentiongrid/product.rb
 - lib/retentiongrid/version.rb
 - log/.gitkeep
 - retentiongrid.gemspec
@@ -165,7 +182,7 @@ files:
 - spec/models/customer_spec.rb
 - spec/models/order_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/christoph-buente/retentiongrid
+homepage: http://retentiongrid.com/
 licenses:
 - MIT
 metadata: {}