solidus_api 2.3.1 → 2.4.0.beta1

data/app/views/spree/api/shipments/_big.json.jbuilder

@@ -0,0 +1,51 @@
+json.cache! [I18n.locale, shipment] do
+  json.(shipment, *shipment_attributes)
+  json.selected_shipping_rate do
+    if shipment.selected_shipping_rate
+      json.partial!("spree/api/shipping_rates/shipping_rate", shipping_rate: shipment.selected_shipping_rate)
+    else
+      json.nil!
+    end
+  end
+  json.inventory_units(shipment.inventory_units) do |inventory_unit|
+    json.(inventory_unit, *inventory_unit_attributes)
+    json.variant do
+      json.partial!("spree/api/variants/small", variant: inventory_unit.variant)
+      json.(inventory_unit.variant, :product_id)
+      json.images(inventory_unit.variant.images) do |image|
+        json.partial!("spree/api/images/image", image: image)
+      end
+    end
+    json.line_item do
+      json.(inventory_unit.line_item, *line_item_attributes)
+      json.single_display_amount(inventory_unit.line_item.single_display_amount.to_s)
+      json.display_amount(inventory_unit.line_item.display_amount.to_s)
+      json.total(inventory_unit.line_item.total)
+    end
+  end
+  json.order do
+    json.partial!("spree/api/orders/order", order: shipment.order)
+    json.bill_address do
+      if shipment.order.billing_address
+        json.partial!("spree/api/addresses/address", address: shipment.order.billing_address)
+      else
+        json.nil!
+      end
+    end
+    json.ship_address do
+      json.partial!("spree/api/addresses/address", address: shipment.order.shipping_address)
+    end
+    json.adjustments(shipment.order.adjustments) do |adjustment|
+      json.partial!("spree/api/adjustments/adjustment", adjustment: adjustment)
+    end
+    json.payments(shipment.order.payments) do |payment|
+      json.(payment, :id, :amount, :display_amount, :state)
+      json.source do
+        attrs = [:id]
+        (attrs << :cc_type) if payment.source.respond_to?(:cc_type)
+        json.(payment.source, *attrs)
+      end
+      json.payment_method { json.(payment.payment_method, :id, :name) }
+    end
+  end
+end

data/app/views/spree/api/shipments/_small.json.jbuilder

@@ -0,0 +1,32 @@
+json.cache! [I18n.locale, shipment] do
+  json.(shipment, *shipment_attributes)
+  json.order_id(shipment.order.number)
+  json.stock_location_name(shipment.stock_location.name)
+  json.shipping_rates(shipment.shipping_rates) do |shipping_rate|
+    json.partial!("spree/api/shipping_rates/shipping_rate", shipping_rate: shipping_rate)
+  end
+  json.selected_shipping_rate do
+    if shipment.selected_shipping_rate
+      json.partial!("spree/api/shipping_rates/shipping_rate", shipping_rate: shipment.selected_shipping_rate)
+    else
+      json.nil!
+    end
+  end
+  json.shipping_methods(shipment.shipping_methods) do |shipping_method|
+    json.(shipping_method, :id, :code, :name)
+    json.zones(shipping_method.zones) do |zone|
+      json.(zone, :id, :name, :description)
+    end
+    json.shipping_categories(shipping_method.shipping_categories) do |shipping_category|
+      json.(shipping_category, :id, :name)
+    end
+  end
+  json.manifest(shipment.manifest) do |manifest_item|
+    json.variant_id manifest_item.variant.id
+    json.quantity(manifest_item.quantity)
+    json.states(manifest_item.states)
+  end
+  json.adjustments(shipment.adjustments) do |adjustment|
+    json.partial!("spree/api/adjustments/adjustment", adjustment: adjustment)
+  end
+end

data/app/views/spree/api/shipments/cannot_ready_shipment.json.jbuilder

@@ -0,0 +1 @@
+json.error(I18n.t(:cannot_ready, scope: "spree.api.shipment"))

data/app/views/spree/api/shipments/mine.json.jbuilder

@@ -0,0 +1,4 @@
+json.partial! 'spree/api/shared/pagination', pagination: @shipments
+json.shipments(@shipments) do |shipment|
+  json.partial!("spree/api/shipments/big", shipment: shipment)
+end

data/app/views/spree/api/shipments/show.json.jbuilder

@@ -0,0 +1,31 @@
+json.cache! [I18n.locale, @shipment] do
+  json.(@shipment, *shipment_attributes)
+  json.order_id(@shipment.order.number)
+  json.stock_location_name(@shipment.stock_location.name)
+  json.shipping_rates(@shipment.shipping_rates) do |shipping_rate|
+    json.partial!("spree/api/shipping_rates/shipping_rate", shipping_rate: shipping_rate)
+  end
+  json.selected_shipping_rate do
+    if @shipment.selected_shipping_rate
+      json.partial!("spree/api/shipping_rates/shipping_rate", shipping_rate: @shipment.selected_shipping_rate)
+    else
+      json.nil!
+    end
+  end
+  json.shipping_methods(@shipment.shipping_methods) do |shipping_method|
+    json.(shipping_method, :id, :name)
+    json.zones(shipping_method.zones) do |zone|
+      json.(zone, :id, :name, :description)
+    end
+    json.shipping_categories(shipping_method.shipping_categories) do |shipping_category|
+      json.(shipping_category, :id, :name)
+    end
+  end
+  json.manifest(@shipment.manifest) do |manifest_item|
+    json.variant do
+      json.partial!("spree/api/variants/small", variant: manifest_item.variant)
+    end
+    json.quantity(manifest_item.quantity)
+    json.states(manifest_item.states)
+  end
+end

data/app/views/spree/api/shipping_rates/_shipping_rate.json.jbuilder

@@ -0,0 +1,2 @@
+json.(shipping_rate, :id, :name, :cost, :selected, :shipping_method_id, :shipping_method_code)
+json.display_cost(shipping_rate.display_cost.to_s)

data/app/views/spree/api/states/index.json.jbuilder

@@ -0,0 +1,5 @@
+json.states_required(@country.states_required) if @country
+json.states(@states) { |state| json.(state, *state_attributes) }
+if @states.respond_to?(:total_pages)
+  json.partial! 'spree/api/shared/pagination', pagination: @states
+end

data/app/views/spree/api/states/show.json.jbuilder

@@ -0,0 +1 @@
+json.(@state, *state_attributes)

data/app/views/spree/api/stock_items/_stock_item.json.jbuilder

@@ -0,0 +1,4 @@
+json.(stock_item, *stock_item_attributes)
+json.variant do
+  json.partial!("spree/api/variants/small", variant: stock_item.variant)
+end

data/app/views/spree/api/stock_items/index.json.jbuilder

@@ -0,0 +1,4 @@
+json.stock_items(@stock_items) do |stock_item|
+  json.partial!("spree/api/stock_items/stock_item", stock_item: stock_item)
+end
+json.partial! 'spree/api/shared/pagination', pagination: @stock_items

data/app/views/spree/api/stock_items/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial!("spree/api/stock_items/stock_item", stock_item: @stock_item)

data/app/views/spree/api/stock_locations/_stock_location.json.jbuilder

@@ -0,0 +1,15 @@
+json.(stock_location, *stock_location_attributes)
+json.country do
+  if stock_location.country
+    json.(stock_location.country, *country_attributes)
+  else
+    json.nil!
+  end
+end
+json.state do
+  if stock_location.state
+    json.(stock_location.state, *state_attributes)
+  else
+    json.nil!
+  end
+end

data/app/views/spree/api/stock_locations/index.json.jbuilder

@@ -0,0 +1,4 @@
+json.stock_locations(@stock_locations) do |stock_location|
+  json.partial!("spree/api/stock_locations/stock_location", stock_location: stock_location)
+end
+json.partial! 'spree/api/shared/pagination', pagination: @stock_locations

data/app/views/spree/api/stock_locations/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial!("spree/api/stock_locations/stock_location", stock_location: @stock_location)

data/app/views/spree/api/stock_movements/_stock_movement.json.jbuilder

@@ -0,0 +1,4 @@
+json.(stock_movement, *stock_movement_attributes)
+json.stock_item do
+  json.partial!("spree/api/stock_items/stock_item", stock_item: stock_movement.stock_item)
+end

data/app/views/spree/api/stock_movements/index.json.jbuilder

@@ -0,0 +1,4 @@
+json.stock_movements(@stock_movements) do |stock_movement|
+  json.partial!("spree/api/stock_movements/stock_movement", stock_movement: stock_movement)
+end
+json.partial! 'spree/api/shared/pagination', pagination: @stock_movements

data/app/views/spree/api/stock_movements/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial!("spree/api/stock_movements/stock_movement", stock_movement: @stock_movement)

data/app/views/spree/api/stock_transfers/receive.json.jbuilder

@@ -0,0 +1,4 @@
+json.(@stock_transfer, *stock_transfer_attributes)
+json.received_item do
+  json.partial!("spree/api/transfer_items/transfer_item", transfer_item: @transfer_item)
+end

data/app/views/spree/api/store_credit_events/mine.json.jbuilder

@@ -0,0 +1,5 @@
+json.store_credit_events(@store_credit_events) do |store_credit_event|
+  json.(store_credit_event, *store_credit_history_attributes)
+  json.order_number(store_credit_event.order.try(:number))
+end
+json.partial! 'spree/api/shared/pagination', pagination: @store_credit_events

data/app/views/spree/api/stores/index.json.jbuilder

@@ -0,0 +1 @@
+json.stores(@stores) { |store| json.(store, *store_attributes) }

data/app/views/spree/api/stores/show.json.jbuilder

@@ -0,0 +1 @@
+json.(@store, *store_attributes)

data/app/views/spree/api/taxonomies/_nested.json.jbuilder

@@ -0,0 +1,8 @@
+json.(taxonomy, *taxonomy_attributes)
+json.root do
+  json.(taxonomy.root, *taxon_attributes)
+  json.taxons(taxonomy.root.children) do |taxon|
+    json.(taxon, *taxon_attributes)
+    json.partial!("spree/api/taxons/taxons", taxon: taxon)
+  end
+end

data/app/views/spree/api/taxonomies/_taxonomy.json.jbuilder

@@ -0,0 +1,11 @@
+if params[:set] == "nested"
+  json.partial!("spree/api/taxonomies/nested", taxonomy: taxonomy)
+else
+  json.(taxonomy, *taxonomy_attributes)
+  json.root do
+    json.(taxonomy.root, *taxon_attributes)
+    json.taxons(taxonomy.root.children) do |taxon|
+      json.(taxon, *taxon_attributes)
+    end
+  end
+end

data/app/views/spree/api/taxonomies/index.json.jbuilder

@@ -0,0 +1,4 @@
+json.taxonomies(@taxonomies) do |taxonomy|
+  json.partial!("spree/api/taxonomies/taxonomy", taxonomy: taxonomy)
+end
+json.partial! 'spree/api/shared/pagination', pagination: @taxonomies

data/app/views/spree/api/taxonomies/jstree.json.jbuilder

@@ -0,0 +1,6 @@
+json.data @taxonomy.root.name
+json.attr do
+  json.id @taxonomy.root.id
+  json.name @taxonomy.root.name
+end
+json.state "closed"

data/app/views/spree/api/taxonomies/new.json.jbuilder

@@ -0,0 +1,2 @@
+json.attributes([*taxonomy_attributes])
+json.required_attributes(required_fields_for(Spree::Taxonomy))

data/app/views/spree/api/taxonomies/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial!("spree/api/taxonomies/taxonomy", taxonomy: @taxonomy)

data/app/views/spree/api/taxons/_taxon.json.jbuilder

@@ -0,0 +1,2 @@
+json.(taxon, *taxon_attributes)
+json.taxons(taxon.children) { |taxon| json.(taxon, *taxon_attributes) }

data/app/views/spree/api/taxons/_taxons.json.jbuilder

@@ -0,0 +1,4 @@
+json.taxons(taxon.children) do |taxon|
+  json.(taxon, *taxon_attributes)
+  json.partial!("spree/api/taxons/taxons", taxon: taxon)
+end

data/app/views/spree/api/taxons/index.json.jbuilder

@@ -0,0 +1,7 @@
+json.partial! 'spree/api/shared/pagination', pagination: @taxons
+json.taxons(@taxons) do |taxon|
+  json.(taxon, *taxon_attributes)
+  unless params[:without_children]
+    json.partial!("spree/api/taxons/taxons", taxon: taxon)
+  end
+end

data/app/views/spree/api/taxons/jstree.json.jbuilder

@@ -0,0 +1,8 @@
+json.array!(@taxon.children) do |taxon|
+  json.data taxon.name
+  json.attr do
+    json.id taxon.id
+    json.name taxon.name
+  end
+  json.state "closed"
+end

data/app/views/spree/api/taxons/new.json.jbuilder

@@ -0,0 +1,2 @@
+json.attributes([*taxon_attributes])
+json.required_attributes(required_fields_for(Spree::Taxon))

data/app/views/spree/api/taxons/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial!("spree/api/taxons/taxon", taxon: @taxon)

data/app/views/spree/api/transfer_items/_transfer_item.json.jbuilder

@@ -0,0 +1,5 @@
+json.(transfer_item, *transfer_item_attributes)
+json.variant do
+  json.partial!("spree/api/variants/small", variant: transfer_item.variant)
+  json.(transfer_item.variant, *transfer_item_variant_attributes)
+end

data/app/views/spree/api/transfer_items/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial!("spree/api/transfer_items/transfer_item", transfer_item: @transfer_item)

data/app/views/spree/api/users/_user.json.jbuilder

@@ -0,0 +1,15 @@
+json.(user, *user_attributes)
+json.bill_address do
+  if user.bill_address
+    json.partial!("spree/api/addresses/address", address: user.bill_address)
+  else
+    json.nil!
+  end
+end
+json.ship_address do
+  if user.ship_address
+    json.partial!("spree/api/addresses/address", address: user.ship_address)
+  else
+    json.nil!
+  end
+end

data/app/views/spree/api/users/index.json.jbuilder

@@ -0,0 +1,4 @@
+json.users(@users) do |user|
+  json.partial!("spree/api/users/user", user: user)
+end
+json.partial! 'spree/api/shared/pagination', pagination: @users

data/app/views/spree/api/users/new.json.jbuilder

@@ -0,0 +1,2 @@
+json.attributes([*user_attributes])
+json.required_attributes(required_fields_for(Spree.user_class))

data/app/views/spree/api/users/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial!("spree/api/users/user", user: @user)

data/app/views/spree/api/variants/_big.json.jbuilder

@@ -0,0 +1,13 @@
+json.cache! [I18n.locale, Spree::StockLocation.accessible_by(current_ability), variant] do
+  json.(variant, *variant_attributes)
+  json.partial!("spree/api/variants/small", variant: variant)
+  json.total_on_hand(variant.total_on_hand)
+  json.variant_properties(variant.variant_properties) do |variant_property|
+    json.(variant_property, *variant_property_attributes)
+  end
+  json.stock_items(variant.stock_items.accessible_by(current_ability)) do |stock_item|
+    json.(stock_item, :id, :count_on_hand, :stock_location_id, :backorderable)
+    json.available stock_item.available?
+    json.stock_location_name(stock_item.stock_location.name)
+  end
+end

data/app/views/spree/api/variants/_small.json.jbuilder

@@ -0,0 +1,16 @@
+json.cache! [I18n.locale, variant] do
+  json.(variant, *variant_attributes)
+  json.display_price(variant.display_price.to_s)
+  json.options_text(variant.options_text)
+  json.track_inventory(variant.should_track_inventory?)
+  json.in_stock(variant.in_stock?)
+  json.is_backorderable(variant.is_backorderable?)
+  json.total_on_hand(variant.total_on_hand)
+  json.is_destroyed(variant.destroyed?)
+  json.option_values(variant.option_values) do |option_value|
+    json.(option_value, *option_value_attributes)
+  end
+  json.images(variant.images) do |image|
+    json.partial!("spree/api/images/image", image: image)
+  end
+end

data/app/views/spree/api/variants/index.json.jbuilder

@@ -0,0 +1,4 @@
+json.partial! 'spree/api/shared/pagination', pagination: @variants
+json.variants(@variants) do |variant|
+  json.partial!("spree/api/variants/big", variant: variant)
+end

data/app/views/spree/api/variants/new.json.jbuilder

@@ -0,0 +1,2 @@
+json.attributes([*variant_attributes])
+json.required_attributes([])

data/app/views/spree/api/variants/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial!("spree/api/variants/big", variant: @variant)

data/app/views/spree/api/zones/_zone.json.jbuilder

@@ -0,0 +1,4 @@
+json.(zone, :id, :name, :description)
+json.zone_members(zone.zone_members) do |zone_member|
+  json.(zone_member, :id, :name, :zoneable_type, :zoneable_id)
+end

data/app/views/spree/api/zones/index.json.jbuilder

@@ -0,0 +1,4 @@
+json.zones(@zones) do |zone|
+  json.partial!("spree/api/zones/zone", zone: zone)
+end
+json.partial! 'spree/api/shared/pagination', pagination: @zones

data/app/views/spree/api/zones/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial!("spree/api/zones/zone", zone: @zone)

data/config/locales/en.yml

@@ -7,6 +7,7 @@ en:
       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}"
+      delete_restriction_error: "Cannot delete record."
       access: "API Access"
       key: "Key"
       clear_key: "Clear key"

data/lib/spree/api/engine.rb

@@ -6,16 +6,6 @@ module Spree
       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
-
       initializer "spree.api.environment", before: :load_config_initializers do |_app|
         Spree::Api::Config = Spree::ApiConfiguration.new
       end
@@ -29,10 +19,6 @@ module Spree
           config.extraction_strategy = :http_header
         end
       end
-
-      def self.root
-        @root ||= Pathname.new(File.expand_path('../../../../', __FILE__))
-      end
     end
   end
 end

data/lib/spree/api.rb

@@ -1,6 +1,6 @@
 require 'spree/core'
 
-require 'rabl'
+require 'responders'
 
 module Spree
   module Api

data/lib/spree_api.rb

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

data/solidus_api.gemspec

@@ -21,6 +21,8 @@ Gem::Specification.new do |gem|
   gem.required_rubygems_version = '>= 1.8.23'
 
   gem.add_dependency 'solidus_core', gem.version
-  gem.add_dependency 'rabl', '0.13.0' # FIXME: update for proper rails 5 support
   gem.add_dependency 'versioncake', '~> 3.0'
+  gem.add_dependency 'responders'
+  gem.add_dependency 'jbuilder', '~> 2.6'
+  gem.add_dependency 'kaminari', '>= 0.17', '< 2.0'
 end

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

@@ -62,66 +62,10 @@ describe Spree::Api::BaseController, type: :controller do
     end
   end
 
-  it 'chatches StandardError' do
-    expect(subject).to receive(:authenticate_user).and_return(true)
-    expect(subject).to receive(:load_user_roles).and_return(true)
-    expect(subject).to receive(:index).and_raise("no joy")
-    get :index, params: { token: "fake_key" }
-    expect(json_response).to eq({ "exception" => "no joy" })
-    expect(response.content_type).to eq("application/json")
-  end
-
-  it 'raises Exception' do
-    expect(subject).to receive(:authenticate_user).and_return(true)
-    expect(subject).to receive(:load_user_roles).and_return(true)
-    expect(subject).to receive(:index).and_raise(Exception.new("no joy"))
-    expect {
-      get :index, params: { token: "fake_key" }
-    }.to raise_error(Exception, "no joy")
-  end
-
   it "lets a subclass override the product associations that are eager-loaded" do
     expect(controller.respond_to?(:product_includes, true)).to be
   end
 
-  describe '#error_during_processing' do
-    controller(FakesController) do
-      # GET /foo
-      # Simulates a failed API call.
-      def foo
-        raise StandardError
-      end
-    end
-
-    # What would be placed in config/initializers/spree.rb
-    Spree::Api::BaseController.error_notifier = proc do |e, controller|
-      MockHoneybadger.notify_or_ignore(e, rack_env: controller.request.env)
-    end
-
-    ##
-    # Fake HB alert class
-    class MockHoneybadger
-      # https://github.com/honeybadger-io/honeybadger-ruby/blob/master/lib/honeybadger.rb#L136
-      def self.notify_or_ignore(_exception, _opts = {})
-      end
-    end
-
-    before do
-      user = double(email: "spree@example.com")
-      allow(user).to receive_message_chain :spree_roles, pluck: []
-      allow(Spree.user_class).to receive_messages find_by: user
-      @routes = ActionDispatch::Routing::RouteSet.new.tap do |r|
-        r.draw { get 'foo' => 'fakes#foo' }
-      end
-    end
-
-    it 'should notify notify_error_during_processing' do
-      expect(MockHoneybadger).to receive(:notify_or_ignore).once.with(kind_of(Exception), rack_env: kind_of(Hash))
-      get :foo, params: { token: 123 }
-      expect(response.status).to eq(422)
-    end
-  end
-
   context 'insufficient stock' do
     before do
       expect(subject).to receive(:authenticate_user).and_return(true)

data/spec/requests/spree/api/checkouts_controller_spec.rb

@@ -154,19 +154,6 @@ module Spree
         expect(response.status).to eq(200)
       end
 
-      context "with disallowed payment method" do
-        it "returns not found" do
-          order.update_column(:state, "payment")
-          allow_any_instance_of(Spree::PaymentMethod::BogusCreditCard).to receive(:source_required?).and_return(false)
-          @payment_method.update!(available_to_users: false)
-          expect {
-            put spree.api_checkout_path(order.to_param), params: { order_token: order.guest_token, order: { payments_attributes: [{ payment_method_id: @payment_method.id }] } }
-          }.not_to change { Spree::Payment.count }
-          expect(response.status).to eq(404)
-        end
-      end
-
-
       it "returns errors when source is required and missing" do
         order.update_column(:state, "payment")
         put spree.api_checkout_path(order.to_param), params: { order_token: order.guest_token, order: { payments_attributes: [{ payment_method_id: @payment_method.id }] } }
@@ -362,6 +349,14 @@ module Spree
         expect(PromotionHandler::Coupon).to receive(:new).with(order).and_call_original
         expect_any_instance_of(PromotionHandler::Coupon).to receive(:apply).and_return({ coupon_applied?: true })
         put spree.api_checkout_path(order.to_param), params: { order_token: order.guest_token, order: { coupon_code: "foobar" } }
+        expect(response.status).to eq(200)
+      end
+
+      it "renders error failing to apply coupon" do
+        order.update_column(:state, "payment")
+        put spree.api_checkout_path(order.to_param), params: { order_token: order.guest_token, order: { coupon_code: "foobar" } }
+        expect(response.status).to eq(422)
+        expect(json_response).to eq({ "error" => "The coupon code you entered doesn't exist. Please try again." })
       end
     end