spree_api_v2 0.2.0

data/lib/solidus_api_v2.rb

@@ -0,0 +1,5 @@
+require 'solidus_core'
+require 'active_model_serializers'
+
+ENV['SOLIDUS_API'] = 'true'
+require 'spree_api_v2/engine'

data/lib/spree_api_v2.rb

@@ -0,0 +1,4 @@
+require 'spree_core'
+require 'active_model_serializers'
+
+require 'spree_api_v2/engine'

data/lib/spree_api_v2/engine.rb

@@ -0,0 +1,21 @@
+module SpreeApiV2
+  class Engine < Rails::Engine
+    require 'spree/core'
+
+    isolate_namespace Spree
+    engine_name ENV['SOLIDUS_API'].nil? ? 'spree_api_v2' : 'solidus_api_v2'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    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
+  end
+end

data/solidus_api_v2.gemspec

@@ -0,0 +1,36 @@
+# encoding: UTF-8
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'solidus_api_v2'
+  s.version     = '0.2.0'
+  s.summary     = 'The V2 API for Solidus.'
+  s.description = 'Adds an assortment of new api endpoints that are JSON API compatible.'
+  s.required_ruby_version = '>= 2.0.0'
+
+  s.author    = 'Ben A. Morgan'
+  s.email     = 'ben@benmorgan.io'
+  s.homepage  = 'http://spree-contrib.github.io/spree_api_v2'
+
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  s.add_dependency 'solidus_api', '~> 1.0'
+  s.add_dependency 'active_model_serializers', '= 0.10.0.rc2'
+
+  s.add_development_dependency 'capybara', '~> 2.4'
+  s.add_development_dependency 'coffee-rails'
+  s.add_development_dependency 'database_cleaner'
+  s.add_development_dependency 'factory_girl', '~> 4.5'
+  s.add_development_dependency 'ffaker'
+  s.add_development_dependency 'rspec-rails',  '~> 3.3'
+  s.add_development_dependency 'rspec-its'
+  s.add_development_dependency 'sass-rails', '~> 5.0.0.beta1'
+  s.add_development_dependency 'selenium-webdriver'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'pg'
+  s.add_development_dependency 'json_spec', '~> 1.1.4'
+  s.add_development_dependency 'shoulda-matchers', '~> 3.0.0'
+end

data/spec/controllers/spree/api/v2/children_controller_spec.rb

@@ -0,0 +1,28 @@
+describe Spree::Api::V2::ChildrenController do
+  routes { Spree::Core::Engine.routes }
+
+  let(:taxon) { create :taxon }
+  let!(:child) { create :taxon, parent: taxon, taxonomy: taxon.taxonomy }
+
+  describe '#index' do
+    context 'by taxon' do
+      it 'can list all the children' do
+        get :index, taxon_id: taxon.id
+        taxon_ids = parse_json(response.body)['data'].map do |taxon|
+          taxon['id']
+        end
+        expect(taxon_ids).to include child.id.to_s
+      end
+    end
+  end
+
+  describe '#show' do
+    context 'by taxon' do
+      it 'will fetch the selected child' do
+        get :show, taxon_id: taxon.id, id: child.id
+        child_id = parse_json(response.body)['data']['id']
+        expect(child_id).to eql child.id.to_s
+      end
+    end
+  end
+end

data/spec/controllers/spree/api/v2/countries_controller_spec.rb

@@ -0,0 +1,25 @@
+describe Spree::Api::V2::CountriesController do
+  routes { Spree::Core::Engine.routes }
+
+  let!(:country) { create :country }
+  let(:state) { create :state, country: country }
+
+  describe '#index' do
+    it 'will list all countries' do
+      get :index
+      expect(JSON.parse(response.body)['data'].length).to eql 1
+    end
+  end
+
+  describe '#show' do
+    it 'will list the selected country' do
+      get :show, id: country.id
+      expect(JSON.parse(response.body)['data']['id']).to eql country.id.to_s
+    end
+
+    it 'will the country via a state' do
+      get :show, state_id: state.id
+      expect(JSON.parse(response.body)['data']['id']).to eql country.id.to_s
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+describe Spree::Api::V2::ImagesController do
+  routes { Spree::Core::Engine.routes }
+
+  let!(:image) { create :image }
+
+  let(:product) { create :product }
+  let(:new_product) { create :product }
+
+  let(:variant) { create :variant, images: [image] }
+  let(:new_variant) { create :variant, images: [create(:image)] }
+
+  describe '#index' do
+    it 'will list the images' do
+      get :index
+      image_ids = parse_json(response.body)['data'].map do |image|
+        image['id']
+      end
+      expect(image_ids).to include image.id.to_s
+    end
+
+    context 'by product id' do
+      it 'will list its images' do
+        product.images << image
+        get :index, product_id: product.id
+        image_ids = parse_json(response.body)['data'].map do |image|
+          image['id']
+        end
+        expect(image_ids).to include image.id.to_s
+      end
+
+      it 'will not list another products images' do
+        get :index, product_id: new_product.id
+        image_ids = parse_json(response.body)['data'].map do |image|
+          image['id']
+        end
+        expect(image_ids).to_not include image.id.to_s
+      end
+    end
+
+    context 'by variant id' do
+      it 'will list its images' do
+        get :index, variant_id: variant.id
+        image_ids = parse_json(response.body)['data'].map do |image|
+          image['id']
+        end
+        expect(image_ids).to include image.id.to_s
+      end
+
+      it 'will not list another variants images' do
+        get :index, variant_id: new_variant.id
+        image_ids = parse_json(response.body)['data'].map do |image|
+          image['id']
+        end
+        expect(image_ids).to_not include image.id.to_s
+      end
+    end
+  end
+
+  describe '#show' do
+    it 'will show the image' do
+      get :show, id: image.id
+      image_id = parse_json(response.body)['data']['id']
+      expect(image_id).to eql image.id.to_s
+    end
+
+    context 'by product id' do
+      it 'will show its image' do
+        product.images << image
+        get :show, id: image.id, product_id: product.id
+        image_id = parse_json(response.body)['data']['id']
+        expect(image_id).to eql image.id.to_s
+      end
+
+      it 'will not show another products image' do
+        get :show, id: image.id, product_id: new_product.id
+        expect(response).to have_http_status 404
+      end
+    end
+
+    context 'by variant id' do
+      it 'will show its image' do
+        get :show, id: image.id, variant_id: variant.id
+        image_id = parse_json(response.body)['data']['id']
+        expect(image_id).to eql image.id.to_s
+      end
+
+      it 'will not show another products image' do
+        get :show, id: image.id, variant_id: new_variant.id
+        expect(response).to have_http_status 404
+      end
+    end
+  end
+end

data/spec/controllers/spree/api/v2/line_items_controller_spec.rb

@@ -0,0 +1,86 @@
+describe Spree::Api::V2::LineItemsController do
+  routes { Spree::Core::Engine.routes }
+
+  let(:order) { create :order }
+  let(:user) { order.user }
+  let(:variant) { create :variant }
+
+  before { user.generate_spree_api_key! }
+
+  describe '#create' do
+    let(:line_item_params) { { order_id: order.id, variant_id: variant.id, quantity: 1 } }
+
+    context 'on success' do
+      it 'will respond with line item' do
+        post :create, token: user.spree_api_key, line_item: line_item_params
+        expect(JSON.parse(response.body)['data']['type']).to eql 'spree_line_items'
+      end
+    end
+
+    context 'when out of range' do
+      before do
+        post :create, token: user.spree_api_key,
+                      line_item: line_item_params.merge(quantity: 123_123_123_123)
+      end
+
+      it 'will respond with quantity too high error' do
+        expect(response.body).to be_json_eql <<-JSON
+          {
+            "errors" : [
+              {
+                "detail" : #{Spree.t('api.errors.quantity_too_high.detail').gsub("\n", '').to_json},
+                "meta" : {},
+                "title" : #{Spree.t('api.errors.quantity_too_high.title').titleize.to_json}
+              }
+            ]
+          }
+        JSON
+      end
+    end
+
+    context 'when record not found' do
+      before do
+        post :create, token: user.spree_api_key, line_item: line_item_params.merge(order_id: 0)
+      end
+
+      it 'will respond with record not found error' do
+        expect(response.body).to be_json_eql <<-JSON
+          {
+            "errors" : [
+              {
+                "detail" : #{Spree.t('api.errors.record_not_found.detail').gsub("\n", '').to_json},
+                "meta" : {},
+                "title" : #{Spree.t('api.errors.record_not_found.title').to_json}
+              }
+            ]
+          }
+        JSON
+      end
+    end
+
+    context 'when record is invalid' do
+      let(:stock_item) { variant.stock_items.first }
+
+      before do
+        quantity = stock_item.count_on_hand + 1
+        stock_item.update(backorderable: false)
+        post :create, token: user.spree_api_key,
+                      line_item: line_item_params.merge(quantity: quantity)
+      end
+
+      it 'will respond with product out of stock' do
+        expect(response.body).to be_json_eql <<-JSON
+          {
+            "errors" : [
+              {
+                "detail" : "#{Spree.t('api.errors.product_out_of_stock.detail').gsub("\n", '')}",
+                "meta" : {},
+                "title" : #{Spree.t('api.errors.product_out_of_stock.title').titleize.to_json}
+              }
+            ]
+          }
+        JSON
+      end
+    end
+  end
+end

data/spec/controllers/spree/api/v2/option_types_controller_spec.rb

@@ -0,0 +1,73 @@
+describe Spree::Api::V2::OptionTypesController do
+  routes { Spree::Core::Engine.routes }
+
+  let!(:option_type) { create :option_type }
+  let(:product) { create :product, option_types: [option_type] }
+  let(:new_product) { create :product }
+
+  describe '#index' do
+    it 'will list all option types' do
+      get :index
+      option_type_ids = parse_json(response.body)['data'].map do |option_type|
+        option_type['id']
+      end
+      expect(option_type_ids).to include option_type.id.to_s
+    end
+
+    context 'by product' do
+      it 'will list option types' do
+        get :index, product_id: product.id
+        option_type_ids = parse_json(response.body)['data'].map do |option_type|
+          option_type['id']
+        end
+        expect(option_type_ids).to include option_type.id.to_s
+      end
+
+      it 'will not list option types belonging to a different product' do
+        get :index, product_id: new_product.id
+        option_type_ids = parse_json(response.body)['data'].map do |option_type|
+          option_type['id']
+        end
+        expect(option_type_ids).to_not include option_type.id.to_s
+      end
+    end
+  end
+
+  describe '#show' do
+    it 'will find selected option_type by id' do
+      get :show, id: option_type.id
+      option_type_id = parse_json(response.body)['data']['id']
+      expect(option_type_id).to eql option_type.id.to_s
+    end
+
+    context 'by product' do
+      it 'will list option types' do
+        get :show, id: option_type.id, product_id: product.id
+        option_type_id = parse_json(response.body)['data']['id']
+        expect(option_type_id).to eql option_type.id.to_s
+      end
+
+      it 'will not list option types belonging to a different product' do
+        get :show, id: option_type.id, product_id: new_product.id
+        expect(response).to have_http_status 404
+      end
+    end
+
+    context 'by option value' do
+      let(:option_value) { create :option_value, option_type: option_type }
+      let(:new_option_value) { create :option_value }
+
+      it 'will list option types' do
+        get :show, option_value_id: option_value.id
+        option_type_id = parse_json(response.body)['data']['id']
+        expect(option_type_id).to eql option_type.id.to_s
+      end
+
+      it 'will not list option types belonging to a different option value' do
+        get :show, option_value_id: new_option_value.id
+        option_type_id = parse_json(response.body)['data']['id']
+        expect(option_type_id).to_not eql option_type.id.to_s
+      end
+    end
+  end
+end

data/spec/controllers/spree/api/v2/option_values_controller_spec.rb

@@ -0,0 +1,88 @@
+describe Spree::Api::V2::OptionValuesController do
+  routes { Spree::Core::Engine.routes }
+
+  let!(:option_value) { create :option_value }
+  let(:new_option_value) { create :option_value }
+  let(:variant) { create :variant, option_values: [option_value] }
+  let(:new_variant) { create :variant }
+
+  describe '#index' do
+    it 'will list all option values' do
+      get :index
+      option_value_ids = parse_json(response.body)['data'].map do |option_value|
+        option_value['id']
+      end
+      expect(option_value_ids).to include option_value.id.to_s
+    end
+
+    context 'by option type' do
+      it 'will list all option values' do
+        get :index, option_type_id: option_value.option_type.id
+        option_value_ids = parse_json(response.body)['data'].map do |option_value|
+          option_value['id']
+        end
+        expect(option_value_ids).to include option_value.id.to_s
+      end
+
+      it 'will not list option value belonging to a different option type' do
+        get :index, option_type_id: new_option_value.option_type.id
+        option_value_ids = parse_json(response.body)['data'].map do |option_value|
+          option_value['id']
+        end
+        expect(option_value_ids).to_not include option_value.id.to_s
+      end
+    end
+
+    context 'by variant' do
+      it 'will list all option values' do
+        get :index, variant_id: variant.id
+        option_value_ids = parse_json(response.body)['data'].map do |option_value|
+          option_value['id']
+        end
+        expect(option_value_ids).to include option_value.id.to_s
+      end
+
+      it 'will not list option value belonging to a different variant' do
+        get :index, variant_id: new_variant.id
+        option_value_ids = parse_json(response.body)['data'].map do |option_value|
+          option_value['id']
+        end
+        expect(option_value_ids).to_not include option_value.id.to_s
+      end
+    end
+  end
+
+  describe '#show' do
+    it 'will find selected option value by id' do
+      get :show, id: option_value.id
+      option_value_id = parse_json(response.body)['data']['id']
+      expect(option_value_id).to eql option_value.id.to_s
+    end
+
+    context 'by option type' do
+      it 'will find option value by option type' do
+        get :show, option_type_id: option_value.option_type.id, id: option_value.id
+        option_value_id = parse_json(response.body)['data']['id']
+        expect(option_value_id).to eql option_value.id.to_s
+      end
+
+      it 'will not find option value belonging to a different option type' do
+        get :show, option_type_id: new_option_value.option_type.id, id: option_value.id
+        expect(response).to have_http_status 404
+      end
+    end
+
+    context 'by variant' do
+      it 'will find option value by option type' do
+        get :show, variant_id: variant.id, id: option_value.id
+        option_value_id = parse_json(response.body)['data']['id']
+        expect(option_value_id).to eql option_value.id.to_s
+      end
+
+      it 'will not find option value belonging to a different option type' do
+        get :show, variant_id: new_variant.id, id: option_value.id
+        expect(response).to have_http_status 404
+      end
+    end
+  end
+end