Skip to content

Latest commit

 

History

History
58 lines (40 loc) · 1.67 KB

README.md

File metadata and controls

58 lines (40 loc) · 1.67 KB
Raw

Spree API with Active Model Serializer

Modified spree api response with Active Model Serializer

Installation

  1. Add this extension to your Gemfile with this line:
gem 'spree_active_model_serializer', github: 'vishalzambre/spree_active_model_serializer', branch: 'master'
  1. Install the gem using Bundler:
bundle install
  1. Copy & run migrations
bundle exec rails g spree_active_model_serializer:install
  1. Restart your server

If your server was running, restart it so that it can find the assets properly.

Testing

First bundle your dependencies, then run rake. rake will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using rake test_app.

bundle
bundle exec rake

When testing your applications integration with this extension you may use it's factories. Simply add this require statement to your spec_helper:

require 'spree_active_model_serializer/factories'

NOTE: If you want to change adapter to json_api add following line to intializers/spree.rb current adapter is modified to support spree existing API responses.

  ActiveModelSerializers.config.adapter = :json_api

In this active_model_serializers 0.10.5 version is used.

Contributing

If you'd like to contribute, please take a look at the instructions for installing dependencies and crafting a good pull request.

Copyright (c) 2016 Vishal Zambre, released under the New BSD License