versacommerce_api 1.0.1

data/lib/versacommerce_api.rb

@@ -0,0 +1,21 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'active_resource'
+require 'active_support/core_ext/class/attribute_accessors'
+require 'digest/md5'
+require 'base64'
+require 'active_resource/connection_ext'
+require 'active_resource/detailed_log_subscriber'
+require 'active_resource/json_errors'
+require 'active_resource/disable_prefix_check'
+require 'active_resource/base_ext'
+
+module VersacommerceAPI
+  # Your code goes here...
+end
+
+require "versacommerce_api/associatable"
+require "versacommerce_api/version"
+require 'versacommerce_api/countable'
+require 'versacommerce_api/resources'
+require 'versacommerce_api/session'

data/lib/versacommerce_api/associatable.rb

@@ -0,0 +1,25 @@
+module VersacommerceAPI
+
+  module Associatable
+    def associated_resource association, pluralize=true
+      association = association.pluralize if pluralize
+    
+      if self.new? or attributes[association]
+        attributes[association]
+      else
+        # dont create traffic if we know already there are no associated records...
+        return [] if self.respond_to?("#{association}_count") && self.send("#{association}_count") == 0 && pluralize
+        klass = "VersacommerceAPI::#{association.classify}".constantize
+        # ensure we don´t have the association already included
+        attributes[association] ||= begin
+          resource_name = self.class.name.split("::").last.tableize
+          klass.prefix = "/api/#{resource_name}/#{self.id}/"
+          pluralize ? klass.find(:all) : klass.find(:one)
+        end
+        klass.root!
+        attributes[association]
+      end
+    end
+  end
+
+end

data/lib/versacommerce_api/cli.rb

@@ -0,0 +1,164 @@
+require 'thor'
+require 'abbrev'
+
+module VersacommerceAPI
+  class Cli < Thor
+    include Thor::Actions
+    
+    class ConfigFileError < StandardError
+    end
+
+    desc "list", "List all saved CONNECTIONs"
+    def list
+      available_connections.each do |c|
+        prefix = default?(c) ? " * " : "   "
+        puts prefix + c
+      end
+    end
+    
+    desc "add [CONNECTION]", "Create a config file for a connection named CONNECTION"
+    def add(connection)
+      file = config_file(connection)
+      if File.exist?(file)
+        raise ConfigFileError, "There is already a config file at #{file}"
+      else
+        config = {'protocol' => 'http'}
+        config['domain']   = ask("Domain (leave blank for #{connection}.versacommerce.de):")
+        config['domain']   = "#{connection}.versacommerce.de" if config['domain'].blank?
+        config['domain']   = "#{config['domain']}.versacommerce.de" unless config['domain'].match(/[.:]/)
+        puts "\nopen http://#{config['domain']}/admin/settings/apps in your browser to get API credentials\n"
+        config['api_key']  = ask("API key :")
+        config['password'] = ask("Password:")
+        create_file(file, config.to_yaml)
+      end
+      if available_connections.one?
+        default(connection)
+      end
+    end
+    
+    desc "remove [CONNECTION]", "Remove the config file for CONNECTION"
+    def remove(connection)
+      file = config_file(connection)
+      if File.exist?(file)
+        remove_file(default_symlink) if default?(connection)
+        remove_file(file)
+      else
+        config_file_not_found_error(file)
+      end
+    end
+    
+    desc "edit [CONNECTION]", "Open the config file for CONNECTION with your default editor"
+    def edit(connection=nil)
+      file = config_file(connection)
+      if File.exist?(file)
+        if ENV['EDITOR'].present?
+          system(ENV['EDITOR'], file)
+        else
+          puts "Please set an editor in the EDITOR environment variable"
+        end
+      else
+        config_file_not_found_error(file)
+      end
+    end
+    
+    desc "show [CONNECTION]", "Show the location and contents of the CONNECTION's config file"
+    def show(connection=nil)
+      connection ||= default_connection
+      file = config_file(connection)
+      if File.exist?(file)
+        puts file
+        puts `cat #{file}`
+      else
+        config_file_not_found_error(file)
+      end
+    end
+    
+    desc "default [CONNECTION]", "Show or set the default connection"
+    def default(connection=nil)
+      if connection
+        target = config_file(connection)
+        if File.exist?(target)
+          remove_file(default_symlink)
+          `ln -s #{target} #{default_symlink}`
+        else
+          config_file_not_found_error(target)
+        end
+      end
+      if File.exist?(default_symlink)
+        puts "Default connection is #{default_connection}"
+      else
+        puts "There is no default connection set"
+      end
+    end
+    
+    desc "console [CONNECTION]", "Startup an API console for CONNECTION"
+    def console(connection=nil)
+      file = config_file(connection)
+      
+      config = YAML.load(File.read(file))
+      puts ""
+      puts "--> Starting interactive API console for #{config['domain']} - #{file}"
+      puts ""
+      VersacommerceAPI::Base.site = site_from_config(config)
+      
+      require 'irb'
+      require 'irb/completion'
+      ARGV.clear
+      IRB.start
+    end
+
+    tasks.keys.abbrev.each do |shortcut, command|
+      map shortcut => command.to_sym
+    end
+
+    private
+    
+    def shop_config_dir
+      @shop_config_dir ||= File.join(ENV['HOME'], '.versacommerce', 'shops')
+    end
+    
+    def default_symlink
+      @default_symlink ||= File.join(shop_config_dir, 'default')
+    end
+    
+    def config_file(connection)
+      if connection
+        File.join(shop_config_dir, "#{connection}.yml")
+      else
+        default_symlink
+      end
+    end
+    
+    def site_from_config(config)
+      protocol = config['protocol'] || 'https'
+      api_key  = config['api_key']
+      password = config['password']
+      domain   = config['domain']
+    
+      VersacommerceAPI::Base.site = "#{protocol}://#{api_key}:#{password}@#{domain}/api"
+    end
+    
+    def available_connections
+      @available_connections ||= begin
+        pattern = File.join(shop_config_dir, "*.yml")
+        Dir.glob(pattern).map { |f| File.basename(f, ".yml") }
+      end
+    end
+    
+    def default_connection_target
+      @default_connection_target ||= File.readlink(default_symlink)
+    end
+    
+    def default_connection
+      @default_connection ||= File.basename(default_connection_target, ".yml")
+    end
+    
+    def default?(connection)
+      default_connection == connection
+    end
+    
+    def config_file_not_found_error(filename)
+      raise ConfigFileError, "Could not find config file at #{filename}"
+    end
+  end
+end

data/lib/versacommerce_api/countable.rb

@@ -0,0 +1,9 @@
+module VersacommerceAPI
+
+  module Countable
+    def count(options = {})
+      Integer(get(:count, options))
+    end
+  end
+
+end

data/lib/versacommerce_api/resources.rb

@@ -0,0 +1,2 @@
+require 'versacommerce_api/resources/base'
+Dir.glob "#{File.dirname(__FILE__)}/resources/*", &method(:require)

data/lib/versacommerce_api/resources/base.rb

@@ -0,0 +1,42 @@
+module VersacommerceAPI
+
+  class Base < ActiveResource::Base
+    extend Countable
+    self.format = :xml
+    self.headers['User-Agent'] = ["VersacommerceAPI/#{VersacommerceAPI::VERSION}",
+                                  "ActiveResource/#{ActiveResource::VERSION::STRING}",
+                                  "Ruby/#{RUBY_VERSION}"].join(' ')
+    
+    def self.all
+      self.find(:all)
+    end
+    
+    def self.root!
+      self.prefix = "/"
+    end
+    
+    class << self
+      def headers
+        if defined?(@headers)
+          @headers
+        elsif superclass != Object && superclass.headers
+          superclass.headers
+        else
+          @headers ||= {}
+        end
+      end
+
+      def activate_session(session)
+        self.site = session.site
+        self.headers.merge!('X-Versacommerce-API-Token' => session.token)
+      end
+
+      def clear_session
+        self.site = nil
+        self.headers.delete('X-Versacommerce-API-Token')
+      end
+    end
+    
+  end
+
+end

data/lib/versacommerce_api/resources/billing_addres.rb

@@ -0,0 +1,9 @@
+module VersacommerceAPI
+
+  class BillingAddres < Base
+    def fullname
+      [firstname, lastname].delete_if(&:blank?).compact * " "
+    end
+  end
+  
+end

data/lib/versacommerce_api/resources/collection.rb

@@ -0,0 +1,6 @@
+module VersacommerceAPI
+
+  class Collection < Base
+  end
+    
+end

data/lib/versacommerce_api/resources/customer.rb

@@ -0,0 +1,6 @@
+module VersacommerceAPI
+
+  class Customer < Base
+  end
+  
+end

data/lib/versacommerce_api/resources/item.rb

@@ -0,0 +1,9 @@
+module VersacommerceAPI
+
+  class Item < Base
+    def product
+      Product.find product_id
+    end
+  end
+  
+end

data/lib/versacommerce_api/resources/link.rb

@@ -0,0 +1,15 @@
+module VersacommerceAPI
+  
+  class Link < Base
+    
+    def linked
+      resource.find(self.linkable_id) if self.linkable_id && resource
+    end
+    
+    def resource
+      "VersaCommerceShopApi::#{self.linkable_type}".constantize rescue nil
+    end
+    
+  end
+  
+end

data/lib/versacommerce_api/resources/linklist.rb

@@ -0,0 +1,11 @@
+module VersacommerceAPI
+
+  class Linklist < Base
+    include Associatable
+    
+    def links
+      associated_resource "link"
+    end
+  end
+  
+end

data/lib/versacommerce_api/resources/order.rb

@@ -0,0 +1,22 @@
+module VersacommerceAPI
+
+  # An order comes by default with three associations: shipping_address, billing_address and customer.
+  # because we already know the amount of data. if you want to include order items use the :include option like:
+  # VersaCommerceShopApi::Order.find(:all, :params => {:include => 'items', :limit => 10})
+  class Order < Base
+    include Associatable
+    
+    def payments
+      associated_resource "payment"
+    end
+    
+    def shipping_address
+      associated_resource "shipping_address", false
+    end
+    
+    def billing_address
+      associated_resource "billing_address", false
+    end
+  end
+  
+end

data/lib/versacommerce_api/resources/page.rb

@@ -0,0 +1,6 @@
+module VersacommerceAPI
+
+  class Page < Base
+  end
+ 
+end

data/lib/versacommerce_api/resources/payment.rb

@@ -0,0 +1,6 @@
+module VersacommerceAPI
+
+  class Payment < Base
+  end
+  
+end

data/lib/versacommerce_api/resources/product.rb

@@ -0,0 +1,55 @@
+module VersacommerceAPI
+
+  class Product < Base
+    include Associatable
+    
+    # compute the price range
+    def price_range
+      prices = variants.collect(&:price)
+      format =  "%0.2f"
+      if prices.min != prices.max
+        "#{format % prices.min} - #{format % prices.max}"
+      else
+        format % prices.min
+      end
+    end
+    
+    def available
+      amount_available(0) && active
+    end
+
+    def amount_available(amount)
+      if considers_stock
+        stock >= amount
+      else
+        true
+      end
+    end
+    
+    def is_variant
+      !product_id.nil?
+    end
+    
+    def properties
+       associated_resource "property"
+    end
+    
+    def product_images
+      associated_resource "product_image"
+    end
+    
+    def variants
+      associated_resource "variant"
+    end
+    
+    def tags
+      return [] if self.respond_to?("tag_list") && self.send("tag_list").blank?
+      tag_list.split(",").map(&:strip)
+    end
+    
+    def featured_image
+      ProductImage.new(:src => featured_image_url)
+    end
+  end
+  
+end

data/lib/versacommerce_api/resources/product_image.rb

@@ -0,0 +1,67 @@
+module VersacommerceAPI
+  
+  class ProductImage < Base
+    
+    def initialize(attributes)
+      super
+      if self.attributes['file']
+        file     = self.attributes['file']
+        data     = file.read
+        type, suffix = file.content_type.split("/")
+        raise ArgumentError.new("file must be an image") unless ((type == "image") && %w(jpeg jpg gif png).include?(suffix))
+        filename = "upload_file.#{suffix}"
+        upload_image(data, filename)
+        self.attributes.delete 'file'
+      end
+    end
+    
+    def pico
+      generate_resized_url(original, :resize, '16x16')
+    end
+    
+    def icon
+      generate_resized_url(original, :resize, '32x32')
+    end
+    
+    def thumb
+      generate_resized_url(original, :resize, '50x50')
+    end
+    
+    def small
+      generate_resized_url(original, :resize, '100x100')
+    end
+    
+    def medium
+      generate_resized_url(original, :resize, '240x240')
+    end
+    
+    def large
+      generate_resized_url(original, :resize, '480x480')
+    end
+    
+    def xlarge
+      generate_resized_url(original, :resize, '960x960')
+    end
+    
+    def standard
+      generate_resized_url(original, :resize, '1024x1024')
+    end
+    
+    def original
+      "http://images.versacommerce.net/++/#{src.gsub("http://", "")}"
+    end
+    
+    def upload_image(data, filename = nil)
+      attributes['image_data'] = Base64.encode64(data)
+      attributes['filename']   = filename unless filename.nil?
+    end
+    
+    private
+    
+    def generate_resized_url(url, command, value)
+      refit_url = url.gsub("\/++\/", "\/#{command}=#{value}\/++\/")
+    end
+    
+  end
+
+end