goca-spree-api 3.1.14.rails.5.0

data/config/routes.rb

@@ -0,0 +1,128 @@
+Spree::Core::Engine.add_routes do
+  namespace :api, defaults: { format: 'json' } do
+    namespace :v1 do
+      resources :promotions, only: [:show]
+
+      resources :products do
+        resources :images
+        resources :variants
+        resources :product_properties
+      end
+
+      concern :order_routes do
+        member do
+          put :approve
+          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
+        end
+      end
+
+      resources :variants do
+        resources :images
+      end
+
+      resources :option_types do
+        resources :option_values
+      end
+      resources :option_values
+
+      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 :stores
+
+      put '/classifications', to: 'classifications#update', as: :classifications
+      get '/taxons/products', to: 'taxons#products', as: :taxon_products
+    end
+
+    spree_path = Rails.application.routes.url_helpers.try(:spree_path, trailing_slash: true) || '/'
+    match 'v:api/*path', to: redirect("#{spree_path}api/v1/%{path}"), via: [:get, :post, :put, :patch, :delete]
+
+    match '*path', to: redirect{ |params, request|
+      format = ".#{params[:format]}" unless params[:format].blank?
+      query  = "?#{request.query_string}" unless request.query_string.blank?
+
+      "#{spree_path}api/v1/#{params[:path]}#{format}#{query}"
+    }, via: [:get, :post, :put, :patch, :delete]
+  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/spree/api/controller_setup.rb

@@ -0,0 +1,20 @@
+require 'spree/api/responders'
+
+module Spree
+  module Api
+    module ControllerSetup
+      def self.included(klass)
+        klass.class_eval do
+          include CanCan::ControllerAdditions
+          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
+    end
+  end
+end

data/lib/spree/api/engine.rb

@@ -0,0 +1,35 @@
+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
+
+      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,30 @@
+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 => e
+          api_behavior
+        end
+
+        def 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.user_class, 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.user_class)
+            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,2 @@
+require 'spree/api'
+require 'spree/api/responders'

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/spree_api.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require_relative '../core/lib/spree/core/version.rb'
+
+Gem::Specification.new do |s|
+  s.authors       = ["Ryan Bigg"]
+  s.email         = ["ryan@spreecommerce.com"]
+  s.description   = %q{Spree's API}
+  s.summary       = %q{Spree's API}
+  s.homepage      = 'https://spreecommerce.com'
+  s.license       = 'BSD-3'
+
+  s.files         = `git ls-files`.split($\).reject { |f| f.match(/^spec/) && !f.match(/^spec\/fixtures/) }
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.name          = "spree_api"
+  s.require_paths = ["lib"]
+  s.version       = Spree.version
+
+  s.add_dependency 'goca-spree-core', s.version
+  s.add_dependency 'rabl', '~> 0.12.0'
+end

metadata

@@ -0,0 +1,221 @@
+--- !ruby/object:Gem::Specification
+name: goca-spree-api
+version: !ruby/object:Gem::Version
+  version: 3.1.14.rails.5.0
+platform: ruby
+authors:
+- Ryan Bigg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2025-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: goca-spree-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.14.rails.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.14.rails.5.0
+- !ruby/object:Gem::Dependency
+  name: rabl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+description: Spree's API
+email:
+- ryan@spreecommerce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- Rakefile
+- app/controllers/spree/api/base_controller.rb
+- app/controllers/spree/api/v1/addresses_controller.rb
+- app/controllers/spree/api/v1/checkouts_controller.rb
+- app/controllers/spree/api/v1/classifications_controller.rb
+- app/controllers/spree/api/v1/countries_controller.rb
+- app/controllers/spree/api/v1/credit_cards_controller.rb
+- app/controllers/spree/api/v1/images_controller.rb
+- app/controllers/spree/api/v1/inventory_units_controller.rb
+- app/controllers/spree/api/v1/line_items_controller.rb
+- app/controllers/spree/api/v1/option_types_controller.rb
+- app/controllers/spree/api/v1/option_values_controller.rb
+- app/controllers/spree/api/v1/orders_controller.rb
+- app/controllers/spree/api/v1/payments_controller.rb
+- app/controllers/spree/api/v1/product_properties_controller.rb
+- app/controllers/spree/api/v1/products_controller.rb
+- app/controllers/spree/api/v1/promotions_controller.rb
+- app/controllers/spree/api/v1/properties_controller.rb
+- app/controllers/spree/api/v1/return_authorizations_controller.rb
+- app/controllers/spree/api/v1/shipments_controller.rb
+- app/controllers/spree/api/v1/states_controller.rb
+- app/controllers/spree/api/v1/stock_items_controller.rb
+- app/controllers/spree/api/v1/stock_locations_controller.rb
+- app/controllers/spree/api/v1/stock_movements_controller.rb
+- app/controllers/spree/api/v1/stores_controller.rb
+- app/controllers/spree/api/v1/taxonomies_controller.rb
+- app/controllers/spree/api/v1/taxons_controller.rb
+- app/controllers/spree/api/v1/users_controller.rb
+- app/controllers/spree/api/v1/variants_controller.rb
+- app/controllers/spree/api/v1/zones_controller.rb
+- app/helpers/spree/api/api_helpers.rb
+- app/models/spree/api_configuration.rb
+- app/views/spree/api/errors/gateway_error.v1.rabl
+- app/views/spree/api/errors/invalid_api_key.v1.rabl
+- app/views/spree/api/errors/invalid_resource.v1.rabl
+- app/views/spree/api/errors/must_specify_api_key.v1.rabl
+- app/views/spree/api/errors/not_found.v1.rabl
+- app/views/spree/api/errors/unauthorized.v1.rabl
+- app/views/spree/api/v1/addresses/show.v1.rabl
+- app/views/spree/api/v1/adjustments/show.v1.rabl
+- app/views/spree/api/v1/config/money.v1.rabl
+- app/views/spree/api/v1/config/show.v1.rabl
+- app/views/spree/api/v1/countries/index.v1.rabl
+- app/views/spree/api/v1/countries/show.v1.rabl
+- app/views/spree/api/v1/credit_cards/index.v1.rabl
+- app/views/spree/api/v1/credit_cards/show.v1.rabl
+- app/views/spree/api/v1/images/index.v1.rabl
+- app/views/spree/api/v1/images/new.v1.rabl
+- app/views/spree/api/v1/images/show.v1.rabl
+- app/views/spree/api/v1/inventory_units/show.rabl
+- app/views/spree/api/v1/line_items/new.v1.rabl
+- app/views/spree/api/v1/line_items/show.v1.rabl
+- app/views/spree/api/v1/option_types/index.v1.rabl
+- app/views/spree/api/v1/option_types/new.v1.rabl
+- app/views/spree/api/v1/option_types/show.v1.rabl
+- app/views/spree/api/v1/option_values/index.v1.rabl
+- app/views/spree/api/v1/option_values/new.v1.rabl
+- app/views/spree/api/v1/option_values/show.v1.rabl
+- app/views/spree/api/v1/orders/address.v1.rabl
+- app/views/spree/api/v1/orders/canceled.v1.rabl
+- app/views/spree/api/v1/orders/cart.v1.rabl
+- app/views/spree/api/v1/orders/complete.v1.rabl
+- app/views/spree/api/v1/orders/could_not_apply_coupon.v1.rabl
+- app/views/spree/api/v1/orders/could_not_transition.v1.rabl
+- app/views/spree/api/v1/orders/index.v1.rabl
+- app/views/spree/api/v1/orders/invalid_shipping_method.v1.rabl
+- app/views/spree/api/v1/orders/mine.v1.rabl
+- app/views/spree/api/v1/orders/order.v1.rabl
+- app/views/spree/api/v1/orders/payment.v1.rabl
+- app/views/spree/api/v1/orders/show.v1.rabl
+- app/views/spree/api/v1/payments/credit_over_limit.v1.rabl
+- app/views/spree/api/v1/payments/index.v1.rabl
+- app/views/spree/api/v1/payments/new.v1.rabl
+- app/views/spree/api/v1/payments/show.v1.rabl
+- app/views/spree/api/v1/payments/update_forbidden.v1.rabl
+- app/views/spree/api/v1/product_properties/index.v1.rabl
+- app/views/spree/api/v1/product_properties/new.v1.rabl
+- app/views/spree/api/v1/product_properties/show.v1.rabl
+- app/views/spree/api/v1/products/index.v1.rabl
+- app/views/spree/api/v1/products/new.v1.rabl
+- app/views/spree/api/v1/products/product.v1.rabl
+- app/views/spree/api/v1/products/show.v1.rabl
+- app/views/spree/api/v1/promotions/handler.v1.rabl
+- app/views/spree/api/v1/promotions/show.v1.rabl
+- app/views/spree/api/v1/properties/index.v1.rabl
+- app/views/spree/api/v1/properties/new.v1.rabl
+- app/views/spree/api/v1/properties/show.v1.rabl
+- app/views/spree/api/v1/return_authorizations/index.v1.rabl
+- app/views/spree/api/v1/return_authorizations/new.v1.rabl
+- app/views/spree/api/v1/return_authorizations/show.v1.rabl
+- app/views/spree/api/v1/shared/stock_location_required.v1.rabl
+- app/views/spree/api/v1/shipments/big.v1.rabl
+- app/views/spree/api/v1/shipments/cannot_ready_shipment.v1.rabl
+- app/views/spree/api/v1/shipments/mine.v1.rabl
+- app/views/spree/api/v1/shipments/show.v1.rabl
+- app/views/spree/api/v1/shipments/small.v1.rabl
+- app/views/spree/api/v1/shipping_rates/show.v1.rabl
+- app/views/spree/api/v1/states/index.v1.rabl
+- app/views/spree/api/v1/states/show.v1.rabl
+- app/views/spree/api/v1/stock_items/index.v1.rabl
+- app/views/spree/api/v1/stock_items/show.v1.rabl
+- app/views/spree/api/v1/stock_locations/index.v1.rabl
+- app/views/spree/api/v1/stock_locations/show.v1.rabl
+- app/views/spree/api/v1/stock_movements/index.v1.rabl
+- app/views/spree/api/v1/stock_movements/show.v1.rabl
+- app/views/spree/api/v1/stores/index.v1.rabl
+- app/views/spree/api/v1/stores/show.v1.rabl
+- app/views/spree/api/v1/taxonomies/index.v1.rabl
+- app/views/spree/api/v1/taxonomies/jstree.rabl
+- app/views/spree/api/v1/taxonomies/nested.v1.rabl
+- app/views/spree/api/v1/taxonomies/new.v1.rabl
+- app/views/spree/api/v1/taxonomies/show.v1.rabl
+- app/views/spree/api/v1/taxons/index.v1.rabl
+- app/views/spree/api/v1/taxons/jstree.rabl
+- app/views/spree/api/v1/taxons/new.v1.rabl
+- app/views/spree/api/v1/taxons/show.v1.rabl
+- app/views/spree/api/v1/taxons/taxons.v1.rabl
+- app/views/spree/api/v1/users/index.v1.rabl
+- app/views/spree/api/v1/users/new.v1.rabl
+- app/views/spree/api/v1/users/show.v1.rabl
+- app/views/spree/api/v1/variants/big.v1.rabl
+- app/views/spree/api/v1/variants/index.v1.rabl
+- app/views/spree/api/v1/variants/new.v1.rabl
+- app/views/spree/api/v1/variants/show.v1.rabl
+- app/views/spree/api/v1/variants/small.v1.rabl
+- app/views/spree/api/v1/zones/index.v1.rabl
+- app/views/spree/api/v1/zones/show.v1.rabl
+- config/initializers/metal_load_paths.rb
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/20100107141738_add_api_key_to_spree_users.rb
+- db/migrate/20120411123334_resize_api_key_field.rb
+- db/migrate/20120530054546_rename_api_key_to_spree_api_key.rb
+- db/migrate/20131017162334_add_index_to_user_spree_api_key.rb
+- lib/spree/api.rb
+- lib/spree/api/controller_setup.rb
+- lib/spree/api/engine.rb
+- lib/spree/api/responders.rb
+- lib/spree/api/responders/rabl_template.rb
+- lib/spree/api/testing_support/caching.rb
+- lib/spree/api/testing_support/helpers.rb
+- lib/spree/api/testing_support/setup.rb
+- lib/spree_api.rb
+- script/rails
+- spec/fixtures/thinking-cat.jpg
+- spree_api.gemspec
+homepage: https://spreecommerce.com
+licenses:
+- BSD-3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Spree's API
+test_files: []