spree_api 1.3.5 → 2.0.0.rc1

data/app/overrides/api_admin_user_edit_form.rb

@@ -1,6 +1,7 @@
-Deface::Override.new(:virtual_path => "spree/admin/users/edit",
-                     :name => "api_admin_user_edit_form",
-                     :insert_after => "[data-hook='admin_user_edit_general_settings']",
-                     :partial => "spree/admin/users/api_fields",
-                     :disabled => false)
-
+if defined?(Deface)
+  Deface::Override.new(:virtual_path => "spree/admin/users/edit",
+                       :name => "api_admin_user_edit_form",
+                       :insert_after => "[data-hook='admin_user_edit_general_settings']",
+                       :partial => "spree/admin/users/api_fields",
+                       :disabled => false)
+end

data/app/views/spree/admin/users/_api_fields.html.erb

@@ -1,32 +1,31 @@
 <fieldset data-hook="admin_user_api_key" class="omega six columns">
-  <legend><%= t('access', :scope => 'spree.api') %></legend>
+  <legend><%= Spree.t('access', :scope => 'api') %></legend>
 
   <% if @user.spree_api_key.present? %>
     <div class="field">
-      <%= label_tag t('key', :scope => 'spree.api') %>:
+      <%= label_tag Spree.t('key', :scope => 'api') %>:
       <%= @user.spree_api_key %>
     </div>
     <div class="filter-actions actions">
       <%= form_tag spree.clear_api_key_admin_user_path(@user), :method => :put do %>
-        <%= button t('clear_key', :scope => 'spree.api'), 'icon-trash' %>
+        <%= button Spree.t('clear_key', :scope => 'api'), 'icon-trash' %>
       <% end %>
 
-      <span class="or"><%= t(:or)%></span>
+      <span class="or"><%= Spree.t(:or)%></span>
     
       <%= form_tag spree.generate_api_key_admin_user_path(@user), :method => :put do %>
-        <%= button t('regenerate_key', :scope => 'spree.api'), 'icon-refresh' %>
+        <%= button Spree.t('regenerate_key', :scope => 'api'), 'icon-refresh' %>
       <% end %>      
     </div>    
 
   <% else %>
 
-    <div class="no-objects-found"><%= t('no_key', :scope => 'spree.api') %></div>
+    <div class="no-objects-found"><%= Spree.t('no_key', :scope => 'api') %></div>
 
     <div class="filter-actions actions">
       <%= form_tag spree.generate_api_key_admin_user_path(@user), :method => :put do %>
-        <%= button t('generate_key', :scope => 'spree.api'), 'icon-key' %>
+        <%= button Spree.t('generate_key', :scope => 'api'), 'icon-key' %>
       <% end %>
     </div>    
   <% end %>
-
 </fieldset>

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

@@ -4,8 +4,8 @@ attributes :id, :firstname, :lastname, :address1, :address2,
            :company, :alternative_phone, :country_id, :state_id,
            :state_name
 child(:country) do |address|
-  attributes :id, :iso_name, :iso, :iso3, :name, :numcode
+  attributes *country_attributes
 end
 child(:state) do |address|
-  attributes :abbr, :country_id, :id, :name
+  attributes *state_attributes
 end

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

@@ -0,0 +1,2 @@
+object @adjustment
+attributes *adjustment_attributes

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

@@ -0,0 +1,2 @@
+object @credit_card
+attributes *creditcard_attributes

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

@@ -0,0 +1,3 @@
+collection @option_types
+
+extends "spree/api/option_types/show"

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

@@ -0,0 +1,5 @@
+object @option_type
+attributes *option_type_attributes
+child :option_values => :option_values do
+  attributes *option_value_attributes
+end

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

@@ -0,0 +1,3 @@
+collection @option_values
+
+extends "spree/api/option_values/show"

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

@@ -0,0 +1,2 @@
+object @option_value
+attributes *option_value_attributes

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

@@ -0,0 +1,2 @@
+object false
+node(:error) { @coupon_message }

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

@@ -1,3 +1,3 @@
-child(:rate_hash => :shipping_methods) do
-  attributes :id, :name, :cost
+child(:shipments => :shipments) do
+  extends "spree/api/shipments/show"
 end

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

@@ -0,0 +1,3 @@
+child :available_payment_methods => :payment_methods do
+  attributes :id, :name, :environment
+end

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

@@ -27,3 +27,11 @@ end
 child :shipments => :shipments do
   extends "spree/api/shipments/show"
 end
+
+child :adjustments => :adjustments do
+  extends "spree/api/adjustments/show"
+end
+
+child :credit_cards => :credit_cards do
+  extends "spree/api/credit_cards/show"
+end

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

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

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

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

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

@@ -0,0 +1,2 @@
+object @property
+attributes *property_attributes

data/app/views/spree/api/shared/stock_location_required.v1.rabl

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

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

@@ -1,7 +1,14 @@
 object @shipment
 attributes *shipment_attributes
 node(:order_id) { |shipment| shipment.order.number }
+node(:stock_location_name) { |shipment| shipment.stock_location.name }
+child :shipping_rates => :shipping_rates do
+  attributes  :id, :cost, :selected, :shipment_id, :shipping_method_id
+end
 child :shipping_method => :shipping_method do
   attributes :name, :zone_id, :shipping_category_id
 end
 
+child :inventory_units => :inventory_units do
+  attribute *inventory_unit_attributes
+end

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

@@ -0,0 +1,14 @@
+object false
+if @country
+  node(:states_required) { @country.states_required }
+end
+
+child(@states => :states) do
+  attributes *state_attributes
+end
+
+if @states.respond_to?(:num_pages)
+  node(:count) { @states.count }
+  node(:current_page) { params[:page] || 1 }
+  node(:pages) { @states.num_pages }
+end

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

@@ -0,0 +1,2 @@
+object @state
+attributes *state_attributes

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

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

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

@@ -0,0 +1,5 @@
+object @stock_item
+attributes *stock_item_attributes
+child(:variant) do
+  extends "spree/api/variants/variant"
+end

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

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

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

@@ -0,0 +1,8 @@
+object @stock_location
+attributes *stock_location_attributes
+child(:country) do |address|
+  attributes *country_attributes
+end
+child(:state) do |address|
+  attributes *state_attributes
+end

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

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

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

@@ -0,0 +1,5 @@
+object @stock_movement
+attributes *stock_movement_attributes
+child :stock_item do
+  extends "spree/api/stock_items/show"
+end

data/app/views/spree/api/taxonomies/jstree.rabl

@@ -0,0 +1,8 @@
+object false
+node(:data) { @taxonomy.root.name }
+node(:attr) do
+  { :id => @taxonomy.root.id,
+    :name => @taxonomy.root.name
+  }
+end
+node(:state) { "closed" }

data/app/views/spree/api/taxons/jstree.rabl

@@ -0,0 +1,8 @@
+collection @taxon.children, :object_root => false
+node(:data) { |taxon| taxon.name }
+node(:attr) do |taxon|
+  { :id => taxon.id,
+    :name => taxon.name
+  }
+end
+node(:state) { "closed" }

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

@@ -7,5 +7,18 @@ node(:pages) { @variants.num_pages }
 child(@variants => :variants) do
   attributes *variant_attributes
   child(:option_values => :option_values) { attributes *option_value_attributes }
-  child(:images => :images) { extends "spree/api/images/show" }
+  child(:images => :images) do
+    attributes *image_attributes
+    code(:urls) do |v|
+      v.attachment.styles.keys.inject({}) { |urls, style| urls[style] = v.attachment.url(style); urls  }
+    end
+  end
+
+  child(:stock_items) do
+    attributes :id, :count_on_hand, :stock_location_id, :backorderable
+
+    glue(:stock_location) do
+      attribute :name => :stock_location_name
+    end
+  end
 end

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

@@ -1,5 +1 @@
 attributes *variant_attributes
-node(:options_text) { |v| v.options_text }
-child :option_values => :option_values do
-  attributes *option_value_attributes
-end

data/config/locales/en.yml

@@ -21,4 +21,5 @@ en:
         invalid_shipping_method: "Invalid shipping method specified."
       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

@@ -15,10 +15,19 @@ Spree::Core::Engine.routes.draw do
     end
 
     resources :images
-    resources :checkouts
+    resources :checkouts do
+      member do
+        put :next
+      end
+    end
+
     resources :variants, :only => [:index] do
     end
 
+    resources :option_types do
+      resources :option_values
+    end
+
     resources :orders do
       resources :return_authorizations
       member do
@@ -39,21 +48,38 @@ Spree::Core::Engine.routes.draw do
         end
       end
 
-      resources :shipments do
+      resources :shipments, :only => [:create, :update] do
         member do
           put :ready
           put :ship
+          put :add
+          put :remove
         end
       end
     end
 
     resources :zones
     resources :countries, :only => [:index, :show]
+    resources :states,    :only => [:index, :show]
     resources :addresses, :only => [:show, :update]
+
     resources :taxonomies do
-      resources :taxons
+      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
+    resources :properties
+    resources :stock_locations do
+      resources :stock_movements
+      resources :stock_items
+    end
   end
 end

data/lib/spree/api.rb

@@ -1,7 +1,5 @@
 require 'spree/core'
 
-require 'spree/api/controller_setup'
-
 require 'rabl'
 
 module Spree

data/lib/spree/api/controller_setup.rb

@@ -1,3 +1,5 @@
+require 'spree/api/responders'
+
 module Spree
   module Api
     module ControllerSetup
@@ -14,12 +16,15 @@ module Spree
           include ActionController::ImplicitRender
           include ActionController::Rescue
           include ActionController::MimeResponds
+          include ActionController::Head
 
           include CanCan::ControllerAdditions
-          include SslRequirement
+          include Spree::Core::ControllerHelpers::Auth
+
           prepend_view_path Rails.root + "app/views"
           append_view_path File.expand_path("../../../app/views", File.dirname(__FILE__))
 
+          self.responder = Spree::Api::Responders::AppResponder
           respond_to :json
         end
       end

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

@@ -12,7 +12,7 @@ module Spree
         end
 
         def stub_authentication!
-          controller.stub :check_for_api_key
+          controller.stub :check_for_user_or_api_key
           Spree::LegacyUser.stub :find_by_spree_api_key => current_api_user
         end
 

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

@@ -9,6 +9,19 @@ module Spree
             user
           end
         end
+
+        # Default kaminari's pagination to a certain range
+        # Means that you don't need to create 25 objects to test pagination
+        def default_per_page(count)
+          before do
+            @current_default_per_page = Kaminari.config.default_per_page
+            Kaminari.config.default_per_page = 1
+          end
+
+          after do
+            Kaminari.config.default_per_page = @current_default_per_page
+          end
+        end
       end
     end
   end

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

@@ -4,7 +4,20 @@ describe Spree::Api::BaseController do
   render_views
   controller(Spree::Api::BaseController) do
     def index
-      render :json => { "products" => [] }
+      render :text => { "products" => [] }.to_json
+    end
+  end
+
+  context "signed in as a user using an authentication extension" do
+    before do
+      controller.stub :try_spree_current_user => stub(:email => "spree@example.com")
+      Spree::Api::Config[:requires_authentication] = true
+    end
+
+    it "can make a request" do
+      api_get :index
+      json_response.should == { "products" => [] }
+      response.status.should == 200
     end
   end