Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hhff/spree_ams

:floppy_disk: A module for Spree's API that responds as per Active Model Serializers
https://github.com/hhff/spree_ams

Last synced: 6 days ago
JSON representation

:floppy_disk: A module for Spree's API that responds as per Active Model Serializers

Host: GitHub
URL: https://github.com/hhff/spree_ams
Owner: hhff
License: bsd-3-clause
Created: 2014-07-15T15:34:41.000Z (over 10 years ago)
Default Branch: 3-0-alpha
Last Pushed: 2018-05-14T01:17:42.000Z (over 6 years ago)
Last Synced: 2024-10-31T11:42:30.150Z (13 days ago)
Language: Ruby
Homepage:
Size: 126 KB
Stars: 15
Watchers: 3
Forks: 35
Open Issues: 8
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

Spree AMS
========

[![Build Status](https://travis-ci.org/hhff/spree_ams.svg)](https://travis-ci.org/hhff/spree_ams)
[![Dependency Status](https://gemnasium.com/hhff/spree_ams.svg)](https://gemnasium.com/hhff/spree_ams)

Spree AMS is a module namspaced under Spree's Api module, providing a Spree Application with a collection of routes that behave identically to the regular api routes, but instead respond with serialized models (via the [Active Model Serializers](https://github.com/rails-api/active_model_serializers) gem).

This gem does not modify Spree's existing API - it can be used alongside this gem.

Installation
------------

Add spree_ams to your Spree store's Gemfile:

```ruby
gem 'spree_ams', :github => 'hhff/spree_ams', :branch => '3-0-alpha'
```

If you'd like to explicitly set the host URL for the Image Serializer to output absolute URLs you'll need to set a config.action_controller.asset_host in your Rails environment configuration.

i.e. for your `development` environment in `config/environments/development.rb` set

```
config.action_controller.asset_host = 'http://localhost:3000'
```

If you're using S3, Paperclip will take care of this for you.

Install the Initializer:

```ruby
rails g spree:api:ams:install
```

Then run ```bundle``` and you're good to go!

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`.

```shell
bundle
bundle exec rake
```

Contributing
------------

Generate docs from the Acceptance Tests (you'll need to generate your dummy test_app first)!

```ruby
rake app:docs:generate
```