cornerstore 0.6.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dfc2a280092553731812a736e6e328ca98c4684a
+  data.tar.gz: 91b3b7e4604d61bf9de7f93f5e9eddfda886bffb
+SHA512:
+  metadata.gz: 0dfd5351f44be439ac06b31fb00d62434affced7c7549f5007cfb14f8aa517f0afe02387e914ebbe0867d1c898913f788fbf77c6bb95d53c7596be294a94c402
+  data.tar.gz: d3eae73f7a1b60d331b2ec5172b09a9094b029f98cccaa13cb743d3c4fd91228c9ec22cb300855f93874ce4956cc8d6fe306fed7c22fd5e2ea6d9139d88161b5

data/.gitignore

@@ -0,0 +1,15 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cornerstore.gemspec
+gemspec

data/README.md

@@ -0,0 +1,75 @@
+# Cornerstore
+
+This is a client for the Cornerstore API-based online shop. Cornerstore allows you to create custom online shops
+with your own front-end code, platform and tool belt choices. Instead of reinventing the wheel however, Cornerstore will
+supply you with common e-commerce resources like products and carts via API. It also includes a checkout and Manager interface,
+so your customers can manage their products and orders without you having to code yet another admin back-end.
+
+Learn more about Cornerstore at http://www.cornerstore.io and http://addons.heroku.com/cornerstore
+
+## Authentication
+
+The gem tries to retrieve your Cornerstore credentials in the following order:
+
+1. It checks if the env variable CORNERSTORE_URL is set and extracts the credentials. If you provisioned
+with Heroku this variable is already configured.
+
+2. If no env variable is available it checks the secrets.yml file on Rails 4.1 or looks for a
+cornerstore.yml on previous versions. See examples/cornerstore.yml for an example.
+
+3. You can always set the credentials directly by using the Cornerstore.subdomain= and Cornerstore.api_key=
+methods.
+
+## Getting products & collections
+
+You can retrieve products from Cornerstore like so:
+
+    product = Cornerstore::Product.find('sugo-al-basilico')
+    product.manufacturer #=> "Fattoria Croccante"
+    
+    product = Cornerstore::Product.find('5900338280000393023')
+    product.name #=> "Sugo Al Basilico"
+
+    collection = Cornerstore::Collection.find('spaghetti').child_collections.first
+    product = collection.products.first
+    product.variants.any? #=> true
+    product.variants.first.price.decimal_amount #=> 12.99
+    
+## Creating carts and adding line items
+
+You can create carts and handle line items as state below. Line items can either be created from scratch or you can
+derive them from a product/variant.
+
+    cart = Cornerstore::Cart.new({
+        success_redirect_url: "http://yourshop.com/cart/success",
+        cart_url:             "http://yourshop.com/cart"
+    })
+    
+    product = Cornerstore::Product.find('sugo-al-basilico')
+    variant = product.variants.find('SBS-39993')
+    
+    # Derive from variant
+    cart.line_items.create_from_variant(variant, qty: 10)
+    
+    line_item = cart.line_items.first
+    line_item.qty = 15
+    line_item.save
+    
+    another_line_item = cart.line_items.last
+    another_line_item.destroy
+    
+    # Create a line item directly
+    line_item = Cornerstore::LineItem.create({
+        qty: 10,
+        description: 'My own custom line item',
+        unit: 'Piece',
+        weight: 0.5,
+        price: Cornerstore::Price.new(12.99, 'USD')
+    })
+
+## Learn more
+
+We provide a full API documentation at http://developer.cornerstore.io/api, including many ruby examples. Generally every
+attribute that is listed in the API docs corresponds to a ruby method that can be called on the respective objects. In
+many cases there are additional methods available, just check out the classes of this gem and our Rails example store
+and boilerplate at https://github.com/crispymtn/fattoria-croccante.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/cornerstore.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cornerstore/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "cornerstore"
+  gem.version       = Cornerstore::VERSION
+  gem.authors       = ['Johannes Treitz', 'Christian Weyer']
+  gem.email         = ['jt@crispymtn.com', 'cw@crispymtn.com']
+  gem.description   = "This is a client for the Cornerstore e-commerce API"
+  gem.summary       = "This is a client for the Cornerstore e-commerce API"
+  gem.homepage      = "https://www.github.com/crispymtn/cornerstore-gem"
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'rest-client'
+  gem.add_dependency 'activemodel'
+  gem.add_development_dependency "rspec"
+
+end

data/examples/cornerstore.yml

@@ -0,0 +1,11 @@
+development:
+  subdomain: your-shop-staging
+  api_key: dffe7d7382199992dfe # You find the API keys in the Cornerstore Manager under Settings > API
+
+test:
+  subdomain: your-shop-staging
+  api_key: dffe7d7382199992dfe
+
+production:
+  subdomain: your-shop
+  api_key: deee636888117727782

data/lib/cornerstore.rb

@@ -0,0 +1,84 @@
+require 'active_model'
+require 'rest_client'
+
+require 'cornerstore/version'
+require 'cornerstore/resource'
+require 'cornerstore/model'
+require 'cornerstore/api'
+
+module RestClient::AbstractResponse
+  def success?
+    (200..207).include? code
+  end
+end
+
+RestClient.log = 'stdout'
+
+module Cornerstore
+  class << self
+    attr_writer :subdomain, :api_key
+  end
+
+  def self.subdomain
+    @subdomain ||= read_config[:subdomain]
+  end
+
+  def self.root_url
+    "https://#{subdomain}.cornerstore.io/api/v1"
+  end
+
+  def self.assets_url
+    "http://cskit-production.s3.amazonaws.com"
+  end
+
+  def self.headers
+    {
+      user_agent: "cornerstore-gem/#{Cornerstore::VERSION}",
+      authorization: "Token #{api_key}"
+    }
+  end
+
+private
+  # We have three levels of configuration
+  # - Can be manually set with accessors on this module
+  # - Can be supplied by Rails secret file
+  # - Can be supplied by a cornerstore yml file
+  # - Can be supplied via CORNERSTORE_URL env variable
+  def self.read_config
+    config = {}
+
+    # ENV variable set beats everything. If we got one we use it regardless
+    # of other config options
+    if ENV.has_key?('CORNERSTORE_URL') and uri = URI.parse(ENV['CORNERSTORE_URL'])
+      config[:subdomain] = uri.host.sub('.cornerstore.io', '')
+      config[:api_key]   = uri.password
+
+    else
+      # Is this Rails?
+      if defined?(Rails)
+        # Try to get the credentials from the secret storage,
+        # if that fails try to read the YAML file
+        if not (Rails.application.respond_to?(:secrets) and
+          config[:subdomain] = Rails.application.secrets.cornerstore_subdomain and
+          config[:api_key] = Rails.application.secrets.cornerstore_api_key)
+
+          yml_path = Rails.root.join('config', 'cornerstore.yml')
+
+          if File.exists?(yml_path) and yaml = YAML.load(File.read(yml_path))
+            config[:subdomain] = yaml[Rails.env]['subdomain']
+            config[:api_key]   = yaml[Rails.env]['api_key']
+          end
+        end
+
+      else
+        raise ArgumentError, 'Could not find any Cornerstore credentials, please set them before proceeding'
+      end
+    end
+
+    return config
+  end
+
+  def self.api_key
+    @api_ley ||= read_config[:api_key]
+  end
+end

data/lib/cornerstore/api.rb

@@ -0,0 +1,18 @@
+require 'cornerstore/api/product'
+require 'cornerstore/api/variant'
+require 'cornerstore/api/price'
+require 'cornerstore/api/property'
+require 'cornerstore/api/differentiating_property'
+require 'cornerstore/api/image'
+require 'cornerstore/api/collection'
+require 'cornerstore/api/cart'
+require 'cornerstore/api/line_item'
+require 'cornerstore/api/search'
+
+require 'cornerstore/api/order'
+require 'cornerstore/api/payment_means'
+require 'cornerstore/api/cancellation'
+require 'cornerstore/api/shipment'
+require 'cornerstore/api/carrier'
+require 'cornerstore/api/address'
+require 'cornerstore/api/customer'

data/lib/cornerstore/api/address.rb

@@ -0,0 +1,12 @@
+class Cornerstore::Address < Cornerstore::Model::Base
+  attr_accessor :firstname,
+                :name,
+                :company,
+                :street,
+                :number,
+                :addition,
+                :town,
+                :zip,
+                :country,
+                :state
+end

data/lib/cornerstore/api/cancellation.rb

@@ -0,0 +1,22 @@
+class Cornerstore::Cancellation < Cornerstore::Model::Base
+  attr_accessor :created_at,
+    :line_item_ids
+
+  alias_method :canceled_at, :created_at
+
+  def initialize(attributes = {}, parent=nil)
+    self.line_item_ids = attributes.delete('canceled_items')
+    self.created_at    = DateTime.parse(attributes.delete('created_at')) unless attributes['created_at'].blank?
+
+    super
+  end
+
+  def line_items
+    return [] unless self.parent
+    self.parent.line_items.select { |li| self.line_item_ids.include?(li.id) }
+  end
+  alias_method :canceled_items, :line_items
+
+  class Resource < Cornerstore::Resource::Base
+  end
+end

data/lib/cornerstore/api/carrier.rb

@@ -0,0 +1,3 @@
+class Cornerstore::Carrier < Cornerstore::Model::Base
+  attr_accessor :name, :service
+end

data/lib/cornerstore/api/cart.rb

@@ -0,0 +1,49 @@
+class Cornerstore::Cart < Cornerstore::Model::Base
+  include Cornerstore::Model::Writable
+
+  attr_accessor :line_items, :reference, :total, :success_redirect_url, :cart_url, :invoice_pdf_callback_url,
+    :delivery_note_pdf_callback_url, :placed_email_callback_url, :shipped_email_callback_url, :paid_email_callback_url, :canceled_email_callback_url
+
+  def initialize(attributes = {}, parent=nil)
+    self.total = Cornerstore::Price.new(attributes.delete('total'))
+    self.line_items = Cornerstore::LineItem::Resource.new(self, attributes.delete('line_items') || [], 'line_items')
+    super
+  end
+
+   def id
+    reference
+  end
+  alias to_param id
+
+  def attributes
+    {
+      reference: reference,
+      success_redirect_url: success_redirect_url,
+      cart_url: cart_url,
+      invoice_pdf_callback_url: invoice_pdf_callback_url,
+      delivery_note_pdf_callback_url: delivery_note_pdf_callback_url,
+      placed_email_callback_url: placed_email_callback_url,
+      shipped_email_callback_url: shipped_email_callback_url,
+      paid_email_callback_url: paid_email_callback_url,
+      canceled_email_callback_url: canceled_email_callback_url
+    }
+  end
+
+  def empty!
+    line_items.delete_all
+    line_items.empty?
+  end
+
+  def empty?
+    line_items.empty?
+  end
+
+  def checkout_url
+    "https://#{Cornerstore.subdomain}.cornerstore.io/checkout/#{self.reference}"
+  end
+
+  class Resource < Cornerstore::Resource::Base
+    include Cornerstore::Resource::Remote
+    include Cornerstore::Resource::Writable
+  end
+end

data/lib/cornerstore/api/collection.rb

@@ -0,0 +1,25 @@
+class Cornerstore::Collection < Cornerstore::Model::Base
+  attr_accessor :name,
+                :parent,
+                :members,
+                :childs,
+                :products,
+                :properties
+                
+  def initialize(attributes = {}, parent = nil)
+    self.products = Cornerstore::Product::Resource.new(self)
+    self.childs = Cornerstore::Collection::Resource.new(self, attributes.delete('child_collections') || [], 'childs')
+    self.properties = Cornerstore::Property::Resource.new(self, attributes.delete('properties') || [])
+    super
+  end
+  
+  def attributes
+    {
+      name: name
+    }
+  end
+  
+  class Resource < Cornerstore::Resource::Base
+    include Cornerstore::Resource::Remote
+  end
+end

data/lib/cornerstore/api/customer.rb

@@ -0,0 +1,4 @@
+class Cornerstore::Customer < Cornerstore::Model::Base
+  attr_accessor :email,
+                :phone
+end

data/lib/cornerstore/api/differentiating_property.rb

@@ -0,0 +1,15 @@
+class Cornerstore::DifferentiatingProperty < Cornerstore::Model::Base
+  attr_accessor :key,
+                :value
+  
+  def attributes
+    {
+      hide_from: hide_from,
+      key: key,
+      value: value
+    }
+  end
+  
+  class Resource < Cornerstore::Resource::Base
+  end
+end

data/lib/cornerstore/api/image.rb

@@ -0,0 +1,20 @@
+class Cornerstore::Image < Cornerstore::Model::Base
+  attr_accessor :cover,
+                :size,
+                :format,
+                :height,
+                :width,
+                :key
+
+
+  alias content_type format
+  alias file_size size
+
+  # small, small_square, medium, medium_square, large
+  def url(w = 600, h = 600, mode = 'crop')
+    "http://res.cloudinary.com/hgzhd1stm/image/upload/c_#{mode},h_#{h},w_#{w}/#{self.key}"
+  end
+
+  class Resource < Cornerstore::Resource::Base
+  end
+end

data/lib/cornerstore/api/line_item.rb

@@ -0,0 +1,74 @@
+class Cornerstore::LineItem < Cornerstore::Model::Base
+  include Cornerstore::Model::Writable
+
+  attr_accessor :order_number,
+                :description,
+                :qty,
+                :unit,
+                :price,
+                :total,
+                :weight,
+                :properties,
+                :product,
+                :variant
+
+  alias cart parent
+
+  validates :order_number, length: { within: 1..50 }
+  validates :description, length: { within: 1..255 }
+  validates :qty, numericality: { greater_than: 0, only_integer: true }
+  validates :unit, length: { within: 1..20 }
+  validates :price, presence: true
+  validates :weight, numericality: { greater_than: 0, allow_nil: true }
+  validate do
+    errors.add(:price, 'Price must be valid') unless price.valid?
+  end
+
+  def initialize(attributes = {}, parent = nil)
+    self.price = Cornerstore::Price.new(attributes.delete('price'))
+    self.total = Cornerstore::Price.new(attributes.delete('total'))
+    self.properties = Cornerstore::Property::Resource.new(self, attributes.delete('properties') || [])
+    self.product = Cornerstore::Product.new(attributes.delete('product')) if attributes['product']
+    self.variant = Cornerstore::Variant.new(attributes.delete('variant'), self.product) if attributes['variant']
+    super
+  end
+
+  def attributes
+    {
+      order_number: order_number,
+      description: description,
+      qty: qty,
+      unit: unit,
+      price: price.attributes,
+      weight: weight
+    }
+  end
+
+  class Resource < Cornerstore::Resource::Base
+    include Cornerstore::Resource::Remote
+    include Cornerstore::Resource::Writable
+
+    def create_from_variant(variant, attr={})
+      attributes = {
+        variant_id: variant.id,
+        product_id: variant.product._id,
+        line_item: attr
+      }
+
+      RestClient.post("#{Cornerstore.root_url}/carts/#{@parent.id}/line_items/derive.json", attributes, Cornerstore.headers) do |response, request, result, &block|
+        if response.code == 201
+          attributes = ActiveSupport::JSON.decode(response)
+          line_item = @klass.new(attributes, @parent)
+        elsif response.code == 422 and data = ActiveSupport::JSON.decode(response) and data.has_key?('errors')
+          line_item = @klass.new(attr, @parent)
+          data['errors'].each_pair do |key, messages|
+            messages.map { |message| line_item.errors.add(key, message) }
+          end
+        end
+
+        push line_item
+        line_item
+      end
+    end
+  end
+end