spree_api 1.0.7 → 1.1.0.rc1

data/app/helpers/spree/api/api_helpers.rb

@@ -0,0 +1,44 @@
+module Spree
+  module Api
+    module ApiHelpers
+      def required_fields_for(model)
+        required_fields = model._validators.select do |field, validations|
+          validations.any? { |v| v.is_a?(ActiveModel::Validations::PresenceValidator) }
+        end.map(&:first) # get fields that are invalid
+        # Permalinks presence is validated, but are really automatically generated
+        # Therefore we shouldn't tell API clients that they MUST send one through
+        required_fields.map!(&:to_s).delete("permalink")
+        required_fields
+      end
+
+      def product_attributes
+        [:id, :name, :description, :price,
+         :available_on, :permalink, :count_on_hand, :meta_description, :meta_keywords]
+      end
+
+      def variant_attributes
+        [:id, :name, :count_on_hand, :sku, :price, :weight, :height, :width, :depth, :is_master, :cost_price]
+      end
+
+      def image_attributes
+        [:id, :position, :attachment_content_type, :attachment_file_name, :type, :attachment_updated_at, :attachment_width, :attachment_height, :alt]
+      end
+
+      def option_value_attributes
+        [:id, :name, :presentation, :option_type_name, :option_type_id]
+      end
+
+      def order_attributes
+        [:id, :number, :item_total, :total, :state, :adjustment_total, :credit_total, :user_id, :created_at, :updated_at, :completed_at, :payment_total, :shipment_state, :payment_state, :email, :special_instructions]
+      end
+
+      def line_item_attributes
+        [:quantity, :price, :variant_id]
+      end
+
+      def option_type_attributes
+        [:id, :name, :presentation, :position]
+      end
+    end
+  end
+end

data/app/models/spree/line_item_decorator.rb

@@ -0,0 +1,3 @@
+Spree::LineItem.class_eval do
+  attr_accessible :quantity, :variant_id, :as => :api
+end

data/app/models/spree/option_value_decorator.rb

@@ -0,0 +1,5 @@
+Spree::OptionValue.class_eval do
+  def option_type_name
+    option_type.name
+  end
+end

data/app/models/spree/order_decorator.rb

@@ -0,0 +1,12 @@
+Spree::Order.class_eval do
+  def self.build_from_api(user, params)
+    order = create
+    params[:line_items].each do |variant_id, quantity|
+      line_item_params = { :variant_id => variant_id, :quantity => quantity }
+      line_item = order.add_variant(Spree::Variant.find(variant_id), quantity)
+    end
+    order.user = user
+    order.email = user.email
+    order
+  end
+end

data/app/models/spree/user_decorator.rb

@@ -0,0 +1,11 @@
+Spree::User.class_eval do
+  def generate_api_key!
+    self.api_key = SecureRandom.hex(24)
+    save!
+  end
+
+  def clear_api_key!
+    self.api_key = nil
+    save!
+  end
+end

data/app/views/spree/api/v1/errors/invalid_api_key.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { I18n.t(:invalid_api_key, :key => api_key, :scope => "spree.api") }

data/app/views/spree/api/v1/errors/invalid_resource.rabl

@@ -0,0 +1,3 @@
+object false
+node(:error) { I18n.t(:invalid_resource, :scope => "spree.api") }
+node(:errors) { @product.errors }

data/app/views/spree/api/v1/errors/must_specify_api_key.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { I18n.t(:must_specify_api_key, :scope => "spree.api") }

data/app/views/spree/api/v1/errors/not_found.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { I18n.t(:resource_not_found, :scope => "spree.api") }

data/app/views/spree/api/v1/errors/unauthorized.rabl

@@ -0,0 +1,2 @@
+object false
+node(:error) { I18n.t(:unauthorized, :scope => "spree.api") }

data/app/views/spree/api/v1/images/show.rabl

@@ -0,0 +1,2 @@
+object @image
+attributes *image_attributes

data/app/views/spree/api/v1/line_items/new.rabl

@@ -0,0 +1,3 @@
+object false
+node(:attributes) { [*line_item_attributes] }
+node(:required_attributes) { [:variant_id, :quantity] }

data/app/views/spree/api/v1/line_items/show.rabl

@@ -0,0 +1,5 @@
+object @line_item
+attributes :quantity, :price
+child :variant do
+  extends "spree/api/v1/variants/variant"
+end

data/app/views/spree/api/v1/orders/could_not_transition.rabl

@@ -0,0 +1,3 @@
+object false
+node(:error) { I18n.t(:could_not_transition, :scope => "spree.api.order") }
+node(:errors) { @order.errors }

data/app/views/spree/api/v1/orders/delivery.rabl

@@ -0,0 +1,3 @@
+child(:rate_hash => :shipping_methods) do
+  attributes :id, :name, :cost
+end

data/app/views/spree/api/v1/orders/index.rabl

@@ -0,0 +1,7 @@
+object false
+child(@orders) do
+  attributes *order_attributes
+end
+node(:count) { @orders.total_count }
+node(:current_page) { params[:page] || 1 }
+node(:pages) { @orders.num_pages }

data/app/views/spree/api/v1/orders/invalid_shipping_method.rabl

@@ -0,0 +1,2 @@
+object false
+node(:errors) { [I18n.t(:invalid_shipping_method, :scope => "spree.api.order")] }

data/app/views/spree/api/v1/orders/show.rabl

@@ -0,0 +1,3 @@
+object @order
+attributes *order_attributes
+extends "spree/api/v1/orders/#{@order.state}"

data/app/views/spree/api/v1/products/index.rabl

@@ -0,0 +1,8 @@
+object false
+node(:count) { @products.total_count }
+node(:current_page) { params[:page] ? params[:page].to_i : 1 }
+node(:pages) { @products.num_pages }
+child(@products) do
+  extends "spree/api/v1/products/show"
+end
+

data/app/views/spree/api/v1/products/new.rabl

@@ -0,0 +1,3 @@
+object false
+node(:attributes) { [*product_attributes] }
+node(:required_attributes) { required_fields_for(Spree::Product) }

data/app/views/spree/api/v1/products/product.rabl

@@ -0,0 +1 @@
+attributes *product_attributes

data/app/views/spree/api/v1/products/show.rabl

@@ -0,0 +1,21 @@
+object @product
+attributes *product_attributes
+child :variants_including_master => :variants do
+  attributes *variant_attributes
+
+  child :option_values => :option_values do
+    attributes *option_value_attributes
+  end
+end
+
+child :images => :images do
+  attributes *image_attributes
+end
+
+child :option_types => :option_types do
+  attributes *option_type_attributes
+
+  child :option_values => :option_values do
+    attributes *option_value_attributes
+  end
+end

data/app/views/spree/api/v1/variants/index.rabl

@@ -0,0 +1,3 @@
+collection @variants
+attributes *variant_attributes
+child(:option_values => :option_values) { attributes *option_value_attributes }

data/app/views/spree/api/v1/variants/new.rabl

@@ -0,0 +1,2 @@
+node(:attributes) { [*variant_attributes] }
+node(:required_attributes) { [] }

data/app/views/spree/api/v1/variants/show.rabl

@@ -0,0 +1,3 @@
+object @variant
+extends "spree/api/v1/variants/variant"
+child(:option_values => :option_values) { attributes *option_value_attributes }

data/app/views/spree/api/v1/variants/variant.rabl

@@ -0,0 +1 @@
+attributes *variant_attributes

data/config/locales/en.yml

@@ -1,16 +1,12 @@
----
 en:
-  api: "API"
-  api:
-    access: "API Access"
-    clear_key: "Clear API key"
-    errors:
-      invalid_event: "Invalid event name, valid names are %{events}"
-      invalid_event_for_object: "Valid event name but not allowed for this object, valid names are %{events}"
-      missing_event: "No event name supplied"
-    generate_key: "Generate API key"
-    key: "API Key"
-    regenerate_key: "Regenerate API key"
-    no_key: "No key defined"
-    key_generated: "API key generated"
-    key_cleared: "API key cleared"
+  spree:
+    api:
+      must_specify_api_key: "You must specify an API key."
+      invalid_api_key: "Invalid API key (%{key}) specified."
+      unauthorized: "You are not authorized to perform that action."
+      invalid_resource: "Invalid resource. Please fix errors and try again."
+      resource_not_found: "The resource you were looking for could not be found."
+
+      order:
+        could_not_transition: "The order could not be transitioned. Please fix the errors and try again."
+        invalid_shipping_method: "Invalid shipping method specified."

data/config/routes.rb

@@ -1,36 +1,22 @@
 Spree::Core::Engine.routes.prepend do
-  namespace :admin do
-    resources :users do
-      member do
-        put :generate_api_key
-        put :clear_api_key
+  namespace :api do
+    scope :module => :v1 do
+      resources :products do
+        resources :variants
+        resources :images
       end
-    end
-  end
 
-  namespace :api do
-    resources :shipments, :except => [:new,:edit] do
-      put :event, :on => :member
-      resources :inventory_units, :except => [:new,:edit] do
-        put :event, :on => :member
+      resources :variants, :only => [:index] do
+        resources :images
       end
-    end
-    resources :orders, :except => [:new,:edit] do
-      put :event, :on => :member
-      resources :shipments, :except => [:new,:edit]
-      resources :line_items, :except => [:new,:edit]
-      resources :inventory_units, :except => [:new,:edit] do
-        put :event, :on => :member
+
+      resources :orders do
+        member do
+          put :address
+        end
+
+        resources :line_items
       end
     end
-    resources :inventory_units, :except => [:new,:edit] do
-      put :event, :on => :member
-    end
-    resources :products, :except => [:new,:edit]
-    resources :countries, :except => [:new,:edit] do
-      resources :states, :except => [:new,:edit]
-    end
-    resources :states, :except => [:new,:edit]
   end
-
 end

data/db/migrate/{20100107141738_add_api_key_to_users.rb → 20100107141738_add_api_key_to_spree_users.rb}

@@ -1,4 +1,4 @@
-class AddApiKeyToUsers < ActiveRecord::Migration
+class AddApiKeyToSpreeUsers < ActiveRecord::Migration
   def change
     add_column :spree_users, :api_key, :string, :limit => 40
   end

data/lib/spree/api.rb

@@ -1,10 +1,13 @@
-require 'spree_core'
-require 'spree_auth'
+require 'spree/core'
+require 'spree/auth'
+
+require 'spree/api/controller_setup'
+
+require 'rabl'
 
 module Spree
   module Api
-
   end
 end
 
-require 'spree/api/engine'
+require 'spree/api/engine'

data/lib/spree/api/controller_setup.rb

@@ -0,0 +1,27 @@
+module Spree
+  module Api
+    module ControllerSetup
+      def self.included(klass)
+        klass.class_eval do
+          include AbstractController::Rendering
+          include AbstractController::ViewPaths
+          include AbstractController::Callbacks
+          include AbstractController::Helpers
+
+          include ActiveSupport::Rescuable
+
+          include ActionController::Rendering
+          include ActionController::ImplicitRender
+          include ActionController::Rescue
+          include ActionController::MimeResponds
+
+          include CanCan::ControllerAdditions
+          append_view_path File.expand_path("../../../app/views", File.dirname(__FILE__))
+          append_view_path Rails.root + "app/views"
+
+          respond_to :json
+        end
+      end
+    end
+  end
+end

data/lib/spree/api/engine.rb

@@ -1,3 +1,5 @@
+require 'rails/engine'
+
 module Spree
   module Api
     class Engine < Rails::Engine
@@ -9,20 +11,8 @@ module Spree
           Rails.configuration.cache_classes ? require(c) : load(c)
         end
       end
-
-      config.autoload_paths += %W(#{config.root}/lib)
       config.to_prepare &method(:activate).to_proc
-    end
-  end
-end
 
-# add helper to all the base controllers
-# Spree::BaseController includes Spree::Core::ControllerHelpers
-require 'spree/core/controller_helpers'
-class << Spree::Core::ControllerHelpers
-  def included_with_analytics(receiver)
-    included_without_analytics(receiver)
-    receiver.send :helper, 'spree/analytics'
+    end
   end
-  alias_method_chain :included, :analytics
 end

data/lib/spree/api/version.rb

@@ -0,0 +1,5 @@
+module Spree
+  module Api
+    VERSION = "1.1.0.beta"
+  end
+end

data/lib/spree_api.rb

@@ -1,3 +1 @@
 require 'spree/api'
-require 'spree/core'
-require 'spree_auth'

data/script/rails

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_PATH = File.expand_path('../..',  __FILE__)
+load File.expand_path('../../spec/dummy/script/rails',  __FILE__)

data/spec/controllers/spree/api/v1/base_controller_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Spree::Api::V1::BaseController do
+  controller(Spree::Api::V1::BaseController) do
+    def index
+      render :json => { "products" => [] }
+    end
+  end
+
+  context "cannot make a request to the API" do
+    it "without an API key" do
+      api_get :index
+      json_response.should == { "error" => "You must specify an API key." }
+      response.status.should == 401
+    end
+
+    it "with an invalid API key" do
+      request.env["X-Spree-Token"] = "fake_key"
+      get :index, {}
+      json_response.should == { "error" => "Invalid API key (fake_key) specified." }
+      response.status.should == 401
+    end
+
+    it "using an invalid token param" do
+      get :index, :token => "fake_key"
+      json_response.should == { "error" => "Invalid API key (fake_key) specified." }
+    end
+  end
+end

data/spec/controllers/spree/api/v1/images_controller_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+module Spree
+  describe Spree::Api::V1::ImagesController do
+    render_views
+
+    let!(:product) { Factory(:product) }
+    let!(:attributes) { [:id, :position, :attachment_content_type, 
+                         :attachment_file_name, :type, :attachment_updated_at, :attachment_width, 
+                         :attachment_height, :alt] }
+
+    before do
+      stub_authentication!
+    end
+
+    it "can upload a new image for a product" do
+      product.images.count.should == 0
+      api_post :create, :product_id => product.to_param, :image => { :attachment => upload_image("thinking-cat.jpg")  }
+      response.status.should == 201
+      json_response.should have_attributes(attributes)
+      product.images.count.should == 1
+    end
+
+    it "can upload a new image for a variant" do
+      product.master.images.count.should == 0
+      api_post :create, :variant_id => product.master.to_param, :image => { :attachment => upload_image("thinking-cat.jpg") }
+      response.status.should == 201
+      json_response.should have_attributes(attributes)
+      product.images.count.should == 1
+    end
+
+    context "working with an existing image" do
+      let!(:product_image) { product.master.images.create!(:attachment => image("thinking-cat.jpg")) }
+
+      it "can update image data" do
+        product_image.position.should == 1
+        api_post :update, :variant_id => product.master.to_param, :image => { :position => 2 }, :id => product_image.id
+        response.status.should == 200
+        json_response.should have_attributes(attributes)
+        product_image.reload.position.should == 2
+      end
+
+      it "can delete an image" do
+        api_delete :destroy, :variant_id => product.master.to_param, :id => product_image.id
+        response.status.should == 200
+        lambda { product_image.reload }.should raise_error(ActiveRecord::RecordNotFound)
+      end
+    end
+  end
+end