spree_api 3.2.9 → 3.3.0.rc1

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

@@ -0,0 +1,409 @@
+require 'spec_helper'
+require 'shared_examples/protect_product_actions'
+
+module Spree
+  describe Api::V1::ProductsController, type: :controller do
+    render_views
+
+    let!(:product) { create(:product) }
+    let!(:inactive_product) { create(:product, available_on: Time.current.tomorrow, name: "inactive") }
+    let(:base_attributes) { Api::ApiHelpers.product_attributes }
+    let(:show_attributes) { base_attributes.dup.push(:has_variants) }
+    let(:new_attributes) { base_attributes }
+
+    let(:product_data) do
+      { name: "The Other Product",
+        price: 19.99,
+        shipping_category_id: create(:shipping_category).id }
+    end
+    let(:attributes_for_variant) do
+      h = attributes_for(:variant).except(:option_values, :product)
+      h.merge({
+        options: [
+          { name: "size", value: "small" },
+          { name: "color", value: "black" }
+        ]
+      })
+    end
+
+    before do
+      stub_authentication!
+    end
+
+    context "as a normal user" do
+      context "with caching enabled" do
+        let!(:product_2) { create(:product) }
+
+        before do
+          ActionController::Base.perform_caching = true
+        end
+
+        it "returns unique products" do
+          api_get :index
+          product_ids = json_response["products"].map { |p| p["id"] }
+          expect(product_ids.uniq.count).to eq(product_ids.count)
+        end
+
+        after do
+          ActionController::Base.perform_caching = false
+        end
+      end
+
+      it "retrieves a list of products" do
+        api_get :index
+        expect(json_response["products"].first).to have_attributes(show_attributes)
+        expect(json_response["total_count"]).to eq(1)
+        expect(json_response["current_page"]).to eq(1)
+        expect(json_response["pages"]).to eq(1)
+        expect(json_response["per_page"]).to eq(Kaminari.config.default_per_page)
+      end
+
+      it "retrieves a list of products by id" do
+        api_get :index, ids: [product.id]
+        expect(json_response["products"].first).to have_attributes(show_attributes)
+        expect(json_response["total_count"]).to eq(1)
+        expect(json_response["current_page"]).to eq(1)
+        expect(json_response["pages"]).to eq(1)
+        expect(json_response["per_page"]).to eq(Kaminari.config.default_per_page)
+      end
+
+      context "product has more than one price" do
+        before { product.master.prices.create currency: "EUR", amount: 22 }
+
+        it "returns distinct products only" do
+          api_get :index
+          expect(assigns(:products).map(&:id).uniq).to eq assigns(:products).map(&:id)
+        end
+      end
+
+      it "retrieves a list of products by ids string" do
+        second_product = create(:product)
+        api_get :index, ids: [product.id, second_product.id].join(",")
+        expect(json_response["products"].first).to have_attributes(show_attributes)
+        expect(json_response["products"][1]).to have_attributes(show_attributes)
+        expect(json_response["total_count"]).to eq(2)
+        expect(json_response["current_page"]).to eq(1)
+        expect(json_response["pages"]).to eq(1)
+        expect(json_response["per_page"]).to eq(Kaminari.config.default_per_page)
+      end
+
+      it "does not return inactive products when queried by ids" do
+        api_get :index, ids: [inactive_product.id]
+        expect(json_response["count"]).to eq(0)
+      end
+
+      it "does not list unavailable products" do
+        api_get :index
+        expect(json_response["products"].first["name"]).not_to eq("inactive")
+      end
+
+      context "pagination" do
+        it "can select the next page of products" do
+          second_product = create(:product)
+          api_get :index, page: 2, per_page: 1
+          expect(json_response["products"].first).to have_attributes(show_attributes)
+          expect(json_response["total_count"]).to eq(2)
+          expect(json_response["current_page"]).to eq(2)
+          expect(json_response["pages"]).to eq(2)
+        end
+
+        it 'can control the page size through a parameter' do
+          create(:product)
+          api_get :index, per_page: 1
+          expect(json_response['count']).to eq(1)
+          expect(json_response['total_count']).to eq(2)
+          expect(json_response['current_page']).to eq(1)
+          expect(json_response['pages']).to eq(2)
+        end
+      end
+
+      it "can search for products" do
+        create(:product, name: "The best product in the world")
+        api_get :index, q: { name_cont: "best" }
+        expect(json_response["products"].first).to have_attributes(show_attributes)
+        expect(json_response["count"]).to eq(1)
+      end
+
+      it "gets a single product" do
+        product.master.images.create!(attachment: image("thinking-cat.jpg"))
+        create(:variant, product: product)
+        product.variants.first.images.create!(attachment: image("thinking-cat.jpg"))
+        product.set_property("spree", "rocks")
+        product.taxons << create(:taxon)
+
+        api_get :show, id: product.to_param
+
+        expect(json_response).to have_attributes(show_attributes)
+        expect(json_response['variants'].first).to have_attributes([:name,
+                                                              :is_master,
+                                                              :price,
+                                                              :images,
+                                                              :in_stock])
+
+        expect(json_response['variants'].first['images'].first).to have_attributes([:attachment_file_name,
+                                                                                :attachment_width,
+                                                                                :attachment_height,
+                                                                                :attachment_content_type,
+                                                                                :mini_url,
+                                                                                :small_url,
+                                                                                :product_url,
+                                                                                :large_url])
+
+        expect(json_response["product_properties"].first).to have_attributes([:value,
+                                                                         :product_id,
+                                                                         :property_name])
+
+        expect(json_response["classifications"].first).to have_attributes([:taxon_id, :position, :taxon])
+        expect(json_response["classifications"].first['taxon']).to have_attributes([:id, :name, :pretty_name, :permalink, :taxonomy_id, :parent_id])
+      end
+
+      context "tracking is disabled" do
+        before { Config.track_inventory_levels = false }
+
+        it "still displays valid json with total_on_hand Float::INFINITY" do
+          api_get :show, id: product.to_param
+          expect(response).to be_ok
+          expect(json_response[:total_on_hand]).to eq nil
+        end
+
+        after { Config.track_inventory_levels = true }
+      end
+
+      context "finds a product by slug first then by id" do
+        let!(:other_product) { create(:product, slug: "these-are-not-the-droids-you-are-looking-for") }
+
+        before do
+          product.update_column(:slug, "#{other_product.id}-and-1-ways")
+        end
+
+        specify do
+          api_get :show, id: product.to_param
+          expect(json_response["slug"]).to match(/and-1-ways/)
+          product.destroy
+
+          api_get :show, id: other_product.id
+          expect(json_response["slug"]).to match(/droids/)
+        end
+      end
+
+      it "cannot see inactive products" do
+        api_get :show, id: inactive_product.to_param
+        assert_not_found!
+      end
+
+      it "returns a 404 error when it cannot find a product" do
+        api_get :show, id: "non-existant"
+        assert_not_found!
+      end
+
+      it "can learn how to create a new product" do
+        api_get :new
+        expect(json_response["attributes"]).to eq(new_attributes.map(&:to_s))
+        required_attributes = json_response["required_attributes"]
+        expect(required_attributes).to include("name")
+        expect(required_attributes).to include("price")
+        expect(required_attributes).to include("shipping_category")
+      end
+
+      it_behaves_like "modifying product actions are restricted"
+    end
+
+    context "as an admin" do
+      let(:taxon_1) { create(:taxon) }
+      let(:taxon_2) { create(:taxon) }
+
+      sign_in_as_admin!
+
+      it "can see all products" do
+        api_get :index
+        expect(json_response["products"].count).to eq(2)
+        expect(json_response["count"]).to eq(2)
+        expect(json_response["current_page"]).to eq(1)
+        expect(json_response["pages"]).to eq(1)
+      end
+
+      # Regression test for #1626
+      context "deleted products" do
+        before do
+          create(:product, deleted_at: 1.day.ago)
+        end
+
+        it "does not include deleted products" do
+          api_get :index
+          expect(json_response["products"].count).to eq(2)
+        end
+
+        it "can include deleted products" do
+          api_get :index, show_deleted: 1
+          expect(json_response["products"].count).to eq(3)
+        end
+      end
+
+      describe "creating a product" do
+        it "can create a new product" do
+          api_post :create, product: { name: "The Other Product",
+                                          price: 19.99,
+                                          shipping_category_id: create(:shipping_category).id }
+          expect(json_response).to have_attributes(base_attributes)
+          expect(response.status).to eq(201)
+        end
+
+        it "creates with embedded variants" do
+          product_data.merge!({
+            variants: [attributes_for_variant, attributes_for_variant]
+          })
+
+          api_post :create, product: product_data
+          expect(response.status).to eq 201
+
+          variants = json_response['variants']
+          expect(variants.count).to eq(2)
+          expect(variants.last['option_values'][0]['name']).to eq('small')
+          expect(variants.last['option_values'][0]['option_type_name']).to eq('size')
+
+          expect(json_response['option_types'].count).to eq(2) # size, color
+        end
+
+        it "can create a new product with embedded product_properties" do
+          product_data.merge!({
+            product_properties_attributes: [{
+              property_name: "fabric",
+              value: "cotton"
+            }]
+          })
+
+          api_post :create, product: product_data
+
+          expect(json_response['product_properties'][0]['property_name']).to eq('fabric')
+          expect(json_response['product_properties'][0]['value']).to eq('cotton')
+        end
+
+        it "can create a new product with option_types" do
+          product_data.merge!({
+            option_types: ['size', 'color']
+          })
+
+          api_post :create, product: product_data
+          expect(json_response['option_types'].count).to eq(2)
+        end
+
+        it "creates product with option_types ids" do
+          option_type = create(:option_type)
+          product_data.merge!(option_type_ids: [option_type.id])
+          api_post :create, product: product_data
+          expect(json_response['option_types'].first['id']).to eq option_type.id
+        end
+
+        it "creates with shipping categories" do
+          hash = { name: "The Other Product",
+                   price: 19.99,
+                   shipping_category: "Free Ships" }
+
+          api_post :create, product: hash
+          expect(response.status).to eq 201
+
+          shipping_id = ShippingCategory.find_by_name("Free Ships").id
+          expect(json_response['shipping_category_id']).to eq shipping_id
+        end
+
+        it "puts the created product in the given taxons" do
+          product_data[:taxon_ids] = [taxon_1.id, taxon_2.id]
+          api_post :create, product: product_data
+          expect(json_response["taxon_ids"]).to eq([taxon_1.id, taxon_2.id])
+        end
+
+        # Regression test for #2140
+        context "with authentication_required set to false" do
+          before do
+            Spree::Api::Config.requires_authentication = false
+          end
+
+          after do
+            Spree::Api::Config.requires_authentication = true
+          end
+
+          it "can still create a product" do
+            api_post :create, product: product_data, token: "fake"
+            expect(json_response).to have_attributes(show_attributes)
+            expect(response.status).to eq(201)
+          end
+        end
+
+        it "cannot create a new product with invalid attributes" do
+          api_post :create, product: { foo: :bar }
+          expect(response.status).to eq(422)
+          expect(json_response["error"]).to eq("Invalid resource. Please fix errors and try again.")
+          errors = json_response["errors"]
+          errors.delete("slug") # Don't care about this one.
+          expect(errors.keys).to match_array(["name", "price", "shipping_category"])
+        end
+      end
+
+      context 'updating a product' do
+        it "can update a product" do
+          api_put :update, id: product.to_param, product: { name: "New and Improved Product!" }
+          expect(response.status).to eq(200)
+        end
+
+        it "can create new option types on a product" do
+          api_put :update, id: product.to_param, product: { option_types: ['shape', 'color'] }
+          expect(json_response['option_types'].count).to eq(2)
+        end
+
+        it "can create new variants on a product" do
+          api_put :update, id: product.to_param, product: { variants: [attributes_for_variant, attributes_for_variant.merge(sku: "ABC-#{Kernel.rand(9999)}")] }
+          expect(response.status).to eq 200
+          expect(json_response['variants'].count).to eq(2) # 2 variants
+
+          variants = json_response['variants'].select { |v| !v['is_master'] }
+          expect(variants.last['option_values'][0]['name']).to eq('small')
+          expect(variants.last['option_values'][0]['option_type_name']).to eq('size')
+
+          expect(json_response['option_types'].count).to eq(2) # size, color
+        end
+
+        it "can update an existing variant on a product" do
+          variant_hash = {
+            sku: '123', price: 19.99, options: [{name: "size", value: "small"}]
+          }
+          variant_id = product.variants.create!({ product: product }.merge(variant_hash)).id
+
+          api_put :update, id: product.to_param, product: {
+            variants: [
+              variant_hash.merge(
+                id: variant_id.to_s,
+                sku: '456',
+                options: [{name: "size", value: "large" }]
+              )
+            ]
+          }
+
+          expect(json_response['variants'].count).to eq(1)
+          variants = json_response['variants'].select { |v| !v['is_master'] }
+          expect(variants.last['option_values'][0]['name']).to eq('large')
+          expect(variants.last['sku']).to eq('456')
+          expect(variants.count).to eq(1)
+        end
+
+        it "cannot update a product with an invalid attribute" do
+          api_put :update, id: product.to_param, product: { name: "" }
+          expect(response.status).to eq(422)
+          expect(json_response["error"]).to eq("Invalid resource. Please fix errors and try again.")
+          expect(json_response["errors"]["name"]).to eq(["can't be blank"])
+        end
+
+        it "puts the updated product in the given taxons" do
+          api_put :update, id: product.to_param, product: { taxon_ids: [taxon_1.id, taxon_2.id] }
+          expect(json_response["taxon_ids"].to_set).to eql([taxon_1.id, taxon_2.id].to_set)
+        end
+      end
+
+      it "can delete a product" do
+        expect(product.deleted_at).to be_nil
+        api_delete :destroy, id: product.to_param
+        expect(response.status).to eq(204)
+        expect(product.reload.deleted_at).not_to be_nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+module Spree
+  describe Api::V1::OrdersController, type: :controller do
+    render_views
+
+    before do
+      stub_authentication!
+    end
+
+    context "with an available promotion" do
+      let!(:order) { create(:order_with_line_items, line_items_count: 1) }
+      let!(:promotion) do 
+        promotion = Spree::Promotion.create(name: "10% off", code: "10off")
+        calculator = Spree::Calculator::FlatPercentItemTotal.create(preferred_flat_percent: "10")
+        action = Spree::Promotion::Actions::CreateItemAdjustments.create(calculator: calculator)
+        promotion.actions << action
+        promotion
+      end
+
+      it "can apply a coupon code to the order" do
+        expect(order.total).to eq(110.00)
+        api_put :apply_coupon_code, id: order.to_param, coupon_code: "10off", order_token: order.guest_token
+        expect(response.status).to eq(200)
+        expect(order.reload.total).to eq(109.00)
+        expect(json_response["success"]).to eq("The coupon code was successfully applied to your order.")
+        expect(json_response["error"]).to be_blank
+        expect(json_response["successful"]).to be true
+        expect(json_response["status_code"]).to eq("coupon_code_applied")
+      end
+
+      context "with an expired promotion" do
+        before do
+          promotion.starts_at = 2.weeks.ago
+          promotion.expires_at = 1.week.ago
+          promotion.save
+        end
+
+        it "fails to apply" do
+          api_put :apply_coupon_code, id: order.to_param, coupon_code: "10off", order_token: order.guest_token
+          expect(response.status).to eq(422)
+          expect(json_response["success"]).to be_blank
+          expect(json_response["error"]).to eq("The coupon code is expired")
+          expect(json_response["successful"]).to be false
+          expect(json_response["status_code"]).to eq("coupon_code_expired")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+module Spree
+  describe Api::V1::PromotionsController, type: :controller do
+    render_views
+
+    shared_examples "a JSON response" do
+      it 'should be ok' do
+        expect(subject).to be_ok
+      end
+
+      it 'should return JSON' do
+        payload = HashWithIndifferentAccess.new(JSON.parse(subject.body))
+        expect(payload).to_not be_nil
+        Spree::Api::ApiHelpers.promotion_attributes.each do |attribute|
+          expect(payload.has_key?(attribute)).to be true
+        end
+      end
+    end
+
+    before do
+      stub_authentication!
+    end
+
+    let(:promotion) { create :promotion, :with_order_adjustment, code: '10off' }
+
+    describe 'GET #show' do
+      subject { api_get :show, id: id }
+
+      context 'when admin' do
+        sign_in_as_admin!
+
+        context 'when finding by id' do
+          let(:id) { promotion.id }
+
+          it_behaves_like "a JSON response"
+        end
+
+        context 'when finding by code' do
+          let(:id) { promotion.code }
+
+          it_behaves_like "a JSON response"
+        end
+
+        context 'when id does not exist' do
+          let(:id) { 'argh' }
+
+          it 'should be 404' do
+            expect(subject.status).to eq(404)
+          end
+        end
+      end
+
+      context 'when non admin' do
+        let(:id) { promotion.id }
+
+        it 'should be unauthorized' do
+          subject
+          assert_unauthorized!
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,102 @@
+require 'spec_helper'
+module Spree
+  describe Api::V1::PropertiesController, type: :controller do
+    render_views
+
+    let!(:property_1) { Property.create!(name: "foo", presentation: "Foo") }
+    let!(:property_2) { Property.create!(name: "bar", presentation: "Bar") }
+
+    let(:attributes) { [:id, :name, :presentation] }
+
+    before do
+      stub_authentication!
+    end
+
+    it "can see a list of all properties" do
+      api_get :index
+      expect(json_response["properties"].count).to eq(2)
+      expect(json_response["properties"].first).to have_attributes(attributes)
+    end
+
+    it "can control the page size through a parameter" do
+      api_get :index, per_page: 1
+      expect(json_response['properties'].count).to eq(1)
+      expect(json_response['current_page']).to eq(1)
+      expect(json_response['pages']).to eq(2)
+    end
+
+    it 'can query the results through a parameter' do
+      api_get :index, q: { name_cont: 'ba' }
+      expect(json_response['count']).to eq(1)
+      expect(json_response['properties'].first['presentation']).to eq property_2.presentation
+    end
+
+    it "retrieves a list of properties by id" do
+      api_get :index, ids: [property_1.id]
+      expect(json_response["properties"].first).to have_attributes(attributes)
+      expect(json_response["count"]).to eq(1)
+    end
+
+    it "retrieves a list of properties by ids string" do
+      api_get :index, ids: [property_1.id, property_2.id].join(",")
+      expect(json_response["properties"].first).to have_attributes(attributes)
+      expect(json_response["properties"][1]).to have_attributes(attributes)
+      expect(json_response["count"]).to eq(2)
+    end
+
+    it "can see a single property" do
+      api_get :show, id: property_1.id
+      expect(json_response).to have_attributes(attributes)
+    end
+
+    it "can see a property by name" do
+      api_get :show, id: property_1.name
+      expect(json_response).to have_attributes(attributes)
+    end
+
+    it "can learn how to create a new property" do
+      api_get :new
+      expect(json_response["attributes"]).to eq(attributes.map(&:to_s))
+      expect(json_response["required_attributes"]).to be_empty
+    end
+
+    it "cannot create a new property if not an admin" do
+      api_post :create, property: { name: "My Property 3" }
+      assert_unauthorized!
+    end
+
+    it "cannot update a property" do
+      api_put :update, id: property_1.name, property: { presentation: "my value 456" }
+      assert_unauthorized!
+    end
+
+    it "cannot delete a property" do
+      api_delete :destroy, id: property_1.id
+      assert_unauthorized!
+      expect { property_1.reload }.not_to raise_error
+    end
+
+    context "as an admin" do
+      sign_in_as_admin!
+
+      it "can create a new property" do
+        expect(Spree::Property.count).to eq(2)
+        api_post :create, property: { name: "My Property 3", presentation: "my value 3" }
+        expect(json_response).to have_attributes(attributes)
+        expect(response.status).to eq(201)
+        expect(Spree::Property.count).to eq(3)
+      end
+
+      it "can update a property" do
+        api_put :update, id: property_1.name, property: { presentation: "my value 456" }
+        expect(response.status).to eq(200)
+      end
+
+      it "can delete a property" do
+        api_delete :destroy, id: property_1.name
+        expect(response.status).to eq(204)
+        expect { property_1.reload }.to raise_error(ActiveRecord::RecordNotFound)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+module Spree
+  describe Api::V1::ReimbursementsController, type: :controller do
+    render_views
+
+    before do
+      stub_authentication!
+    end
+
+    describe '#index' do
+      let!(:reimbursement)   { create(:reimbursement) }
+
+      before do
+        api_get :index
+      end
+ 
+      it 'loads reimbursements' do
+        expect(response.status).to eq(200)
+        expect(json_response['count']).to eq(1)
+      end
+    end
+  end
+end