solidus_api 1.0.0.pre

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

@@ -0,0 +1,9 @@
+object false
+node(:count) { @variants.count }
+node(:total_count) { @variants.total_count }
+node(:current_page) { params[:page] ? params[:page].to_i : 1 }
+node(:pages) { @variants.num_pages }
+
+child(@variants => :variants) do
+  extends "spree/api/variants/big"
+end

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

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

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

@@ -0,0 +1,3 @@
+object @variant
+cache [I18n.locale, @current_user_roles.include?('admin'), 'show', root_object]
+extends "spree/api/variants/big"

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

@@ -0,0 +1,17 @@
+cache [I18n.locale, @current_user_roles.include?('admin'), 'small_variant', root_object]
+
+attributes *variant_attributes
+
+node(:display_price) { |p| p.display_price.to_s }
+node(:options_text) { |v| v.options_text }
+node(:track_inventory) { |v| v.should_track_inventory? }
+node(:in_stock) { |v| v.in_stock? }
+node(:is_backorderable) { |v| v.is_backorderable? }
+node(:total_on_hand) { |v| v.total_on_hand }
+node(:is_destroyed) { |v| v.destroyed? }
+
+child :option_values => :option_values do
+  attributes *option_value_attributes
+end
+
+child(:images => :images) { extends "spree/api/images/show" }

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

@@ -0,0 +1,7 @@
+object false
+child(@zones => :zones) do
+  extends 'spree/api/zones/show'
+end
+node(:count) { @zones.count }
+node(:current_page) { params[:page] || 1 }
+node(:pages) { @zones.num_pages }

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

@@ -0,0 +1,6 @@
+object @zone
+attributes :id, :name, :description
+
+child :zone_members => :zone_members do
+  attributes :id, :name, :zoneable_type, :zoneable_id
+end

data/config/initializers/metal_load_paths.rb

@@ -0,0 +1 @@
+Spree::Api::BaseController.append_view_path(ApplicationController.view_paths)

data/config/locales/en.yml

@@ -0,0 +1,29 @@
+en:
+  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."
+      gateway_error: "There was a problem with the payment gateway: %{text}"
+      access: "API Access"
+      key: "Key"
+      clear_key: "Clear key"
+      regenerate_key: "Regenerate Key"
+      no_key: "No key"
+      generate_key: "Generate API key"
+      key_generated: "Key generated"
+      key_cleared: "Key cleared"
+      order:
+        could_not_transition: "The order could not be transitioned. Please fix the errors and try again."
+        invalid_shipping_method: "Invalid shipping method specified."
+        expected_total_mismatch: "Expected total does not match actual total."
+        quantity_is_not_available: "Quantity is not available for items in your order"
+      payment:
+        credit_over_limit: "This payment can only be credited up to %{limit}. Please specify an amount less than or equal to this number."
+        update_forbidden: "This payment cannot be updated because it is %{state}."
+      shipment:
+        cannot_ready: "Cannot ready shipment."
+      stock_location_required: "A stock_location_id parameter must be provided in order to retrieve stock movements."
+      invalid_taxonomy_id: "Invalid taxonomy id."

data/config/routes.rb

@@ -0,0 +1,139 @@
+Spree::Core::Engine.add_routes do
+  namespace :admin do
+    resources :users do
+      member do
+        put :generate_api_key
+        put :clear_api_key
+      end
+    end
+  end
+
+  namespace :api, defaults: { format: 'json' } do
+    resources :promotions, only: [:show]
+
+    resources :products do
+      resources :images
+      resources :variants
+      resources :product_properties
+    end
+
+    concern :order_routes do
+      member do
+        put :cancel
+        put :empty
+        put :apply_coupon_code
+      end
+
+      resources :line_items
+      resources :payments do
+        member do
+          put :authorize
+          put :capture
+          put :purchase
+          put :void
+          put :credit
+        end
+      end
+
+      resources :addresses, only: [:show, :update]
+
+      resources :return_authorizations do
+        member do
+          put :add
+          put :cancel
+          put :receive
+        end
+      end
+    end
+
+    resources :checkouts, only: [:update], concerns: :order_routes do
+      member do
+        put :next
+        put :advance
+        put :complete
+      end
+    end
+
+    resources :variants do
+      resources :images
+    end
+
+    resources :option_types do
+      resources :option_values
+    end
+
+    resources :option_values, only: :index
+    get '/orders/mine', to: 'orders#mine', as: 'my_orders'
+    get "/orders/current", to: "orders#current", as: "current_order"
+
+    resources :orders, concerns: :order_routes
+
+    resources :zones
+    resources :countries, only: [:index, :show] do
+      resources :states, only: [:index, :show]
+    end
+
+    resources :shipments, only: [:create, :update] do
+      collection do
+        post 'transfer_to_location'
+        post 'transfer_to_shipment'
+        get :mine
+      end
+
+      member do
+        put :ready
+        put :ship
+        put :add
+        put :remove
+      end
+    end
+    resources :states, only: [:index, :show]
+
+    resources :taxonomies do
+      member do
+        get :jstree
+      end
+      resources :taxons do
+        member do
+          get :jstree
+        end
+      end
+    end
+
+    resources :taxons, only: [:index]
+
+    resources :inventory_units, only: [:show, :update]
+
+    resources :users do
+      resources :credit_cards, only: [:index]
+    end
+
+    resources :properties
+    resources :stock_locations do
+      resources :stock_movements
+      resources :stock_items
+    end
+
+    resources :stock_items, only: [:index, :update, :destroy]
+
+    resources :stock_transfers, only: [] do
+      member do
+        post :receive
+      end
+      resources :transfer_items, only: [:create, :update, :destroy]
+    end
+
+    resources :stores
+
+    resources :store_credit_events, only: [] do
+      collection do
+        get :mine
+      end
+    end
+
+    get '/config/money', to: 'config#money'
+    get '/config', to: 'config#show'
+    put '/classifications', to: 'classifications#update', as: :classifications
+    get '/taxons/products', to: 'taxons#products', as: :taxon_products
+  end
+end

data/db/migrate/20100107141738_add_api_key_to_spree_users.rb

@@ -0,0 +1,7 @@
+class AddApiKeyToSpreeUsers < ActiveRecord::Migration
+  def change
+    unless defined?(User)
+      add_column :spree_users, :api_key, :string, :limit => 40
+    end
+  end
+end

data/db/migrate/20120411123334_resize_api_key_field.rb

@@ -0,0 +1,7 @@
+class ResizeApiKeyField < ActiveRecord::Migration
+  def change
+    unless defined?(User)
+      change_column :spree_users, :api_key, :string, :limit => 48
+    end
+  end
+end

data/db/migrate/20120530054546_rename_api_key_to_spree_api_key.rb

@@ -0,0 +1,7 @@
+class RenameApiKeyToSpreeApiKey < ActiveRecord::Migration
+  def change
+    unless defined?(User)
+      rename_column :spree_users, :api_key, :spree_api_key
+    end
+  end
+end

data/db/migrate/20131017162334_add_index_to_user_spree_api_key.rb

@@ -0,0 +1,7 @@
+class AddIndexToUserSpreeApiKey < ActiveRecord::Migration
+  def change
+    unless defined?(User)
+      add_index :spree_users, :spree_api_key
+    end
+  end
+end

data/lib/solidus_api.rb

@@ -0,0 +1 @@
+require 'spree_api'

data/lib/spree/api/engine.rb

@@ -0,0 +1,38 @@
+require 'rails/engine'
+
+module Spree
+  module Api
+    class Engine < Rails::Engine
+      isolate_namespace Spree
+      engine_name 'spree_api'
+
+      Rabl.configure do |config|
+        config.include_json_root = false
+        config.include_child_root = false
+
+        # Motivation here it make it call as_json when rendering timestamps
+        # and therefore display miliseconds. Otherwise it would fall to
+        # JSON.dump which doesn't display the miliseconds
+        config.json_engine = ActiveSupport::JSON
+      end
+
+      config.view_versions = [1]
+      config.view_version_extraction_strategy = :http_header
+
+      initializer "spree.api.environment", :before => :load_config_initializers do |app|
+        Spree::Api::Config = Spree::ApiConfiguration.new
+      end
+
+      def self.activate
+        Dir.glob(File.join(File.dirname(__FILE__), "../../../app/**/*_decorator*.rb")) do |c|
+          Rails.configuration.cache_classes ? require(c) : load(c)
+        end
+      end
+      config.to_prepare &method(:activate).to_proc
+
+      def self.root
+        @root ||= Pathname.new(File.expand_path('../../../../', __FILE__))
+      end
+    end
+  end
+end

data/lib/spree/api/responders/rabl_template.rb

@@ -0,0 +1,31 @@
+module Spree
+  module Api
+    module Responders
+      module RablTemplate
+        def to_format
+          if template
+            render template, :status => options[:status] || 200
+          else
+            super
+          end
+
+        rescue ActionView::MissingTemplate
+          api_behavior
+        end
+
+        def template
+          request.headers['X-Spree-Template'] || controller.params[:template] || options[:default_template]
+        end
+
+        def api_behavior
+          if controller.params[:action] == "destroy"
+            # Render a blank template
+            super
+          else
+            # Do nothing and fallback to the default template
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spree/api/responders.rb

@@ -0,0 +1,11 @@
+require 'spree/api/responders/rabl_template'
+
+module Spree
+  module Api
+    module Responders
+      class AppResponder < ActionController::Responder
+        include RablTemplate
+      end
+    end
+  end
+end

data/lib/spree/api/testing_support/caching.rb

@@ -0,0 +1,10 @@
+RSpec.configure do |config|
+  config.before(:each, :caching => true) do 
+    ActionController::Base.perform_caching = true
+  end
+  
+  config.after(:each, :caching => true) do
+    ActionController::Base.perform_caching = false
+    Rails.cache.clear
+  end
+end

data/lib/spree/api/testing_support/helpers.rb

@@ -0,0 +1,44 @@
+module Spree
+  module Api
+    module TestingSupport
+      module Helpers
+        def json_response
+          case body = JSON.parse(response.body)
+          when Hash
+            body.with_indifferent_access
+          when Array
+            body
+          end
+        end
+
+        def assert_not_found!
+          expect(json_response).to eq({ "error" => "The resource you were looking for could not be found." })
+          expect(response.status).to eq 404
+        end
+
+        def assert_unauthorized!
+          expect(json_response).to eq({ "error" => "You are not authorized to perform that action." })
+          expect(response.status).to eq 401
+        end
+
+        def stub_authentication!
+          allow(Spree.user_class).to receive(:find_by).with(hash_including(:spree_api_key)) { current_api_user }
+        end
+
+        # This method can be overriden (with a let block) inside a context
+        # For instance, if you wanted to have an admin user instead.
+        def current_api_user
+          @current_api_user ||= stub_model(Spree::LegacyUser, email: "spree@example.com")
+        end
+
+        def image(filename)
+          File.open(Spree::Api::Engine.root + "spec/fixtures" + filename)
+        end
+
+        def upload_image(filename)
+          fixture_file_upload(image(filename).path, 'image/jpg')
+        end
+      end
+    end
+  end
+end

data/lib/spree/api/testing_support/setup.rb

@@ -0,0 +1,16 @@
+module Spree
+  module Api
+    module TestingSupport
+      module Setup
+        def sign_in_as_admin!
+          let!(:current_api_user) do
+            user = stub_model(Spree::LegacyUser)
+            allow(user).to receive_message_chain(:spree_roles, :pluck).and_return(["admin"])
+            allow(user).to receive(:has_spree_role?).with("admin").and_return(true)
+            user
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spree/api.rb

@@ -0,0 +1,10 @@
+require 'spree/core'
+
+require 'rabl'
+
+module Spree
+  module Api
+  end
+end
+
+require 'spree/api/engine'

data/lib/spree_api.rb

@@ -0,0 +1,3 @@
+require 'spree/api'
+require 'spree/api/responders'
+require 'versioncake'

data/script/rails

@@ -0,0 +1,9 @@
+#!/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_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/spree/api/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'
+

data/solidus_api.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+version = File.read(File.expand_path("../../SOLIDUS_VERSION", __FILE__)).strip
+
+Gem::Specification.new do |gem|
+  gem.author        = 'Solidus Team'
+  gem.email         = 'contact@solidus.io'
+  gem.description   = %q{Spree's API}
+  gem.summary       = %q{Spree's API}
+  gem.homepage      = ""
+
+  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.name          = "solidus_api"
+  gem.require_paths = ["lib"]
+  gem.version       = version
+
+  gem.add_dependency 'solidus_core', version
+  gem.add_dependency 'rabl', ['>= 0.9.4.pre1', '< 0.12.0']
+  gem.add_dependency 'versioncake', '~> 2.3.1'
+end

data/spec/controllers/spree/api/addresses_controller_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+module Spree
+  describe Api::AddressesController, :type => :controller do
+    render_views
+
+    before do
+      stub_authentication!
+      @address = create(:address)
+      @order = create(:order, :bill_address => @address)
+    end
+
+    context "with their own address" do
+      before do
+        allow_any_instance_of(Order).to receive_messages :user => current_api_user
+      end
+
+      it "gets an address" do
+        api_get :show, :id => @address.id, :order_id => @order.number
+        expect(json_response['address1']).to eq @address.address1
+      end
+
+      it "updates an address" do
+        api_put :update, :id => @address.id, :order_id => @order.number,
+                         :address => { :address1 => "123 Test Lane" }
+        expect(json_response['address1']).to eq '123 Test Lane'
+      end
+
+      it "receives the errors object if address is invalid" do
+        api_put :update, :id => @address.id, :order_id => @order.number,
+                         :address => { :address1 => "" }
+
+        expect(json_response['error']).not_to be_nil
+        expect(json_response['errors']).not_to be_nil
+        expect(json_response['errors']['address1'].first).to eq "can't be blank"
+      end
+    end
+
+    context "on an address that does not belong to this order" do
+      before do
+        @order.bill_address_id = nil
+        @order.ship_address = nil
+      end
+
+      it "cannot retrieve address information" do
+        api_get :show, :id => @address.id, :order_id => @order.number
+        assert_unauthorized!
+      end
+
+      it "cannot update address information" do
+        api_get :update, :id => @address.id, :order_id => @order.number
+        assert_unauthorized!
+      end
+    end
+  end
+end