cross_spec_rails 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61b512fd901ad710a9dbb92e8bc6aab4f601f462
-  data.tar.gz: e695105c0fcb859ad72f4b62a01b5b094031e679
+  metadata.gz: 2d1f9ef42638747daf1d61f6dce14595d9d152c3
+  data.tar.gz: d725d3601926ad2e3e17d078e885b34f433004d0
 SHA512:
-  metadata.gz: 41072a45608e4cd56473e1b120d8c87c4d0ac5afabae868ee7cdddb21ce4b3cbf5a869153d5aaa26ef41d517dfebfcec1fd4d5b1ab29e0fa5f3c1797e4ecbfdf
-  data.tar.gz: 3b6545d08a47420bd2ef774a1f80e96e3a882c5a8b872d306ec44173b6676b5ff080f07853cb123e50f9f46d6b8036ceb5215694c061776efd1c84f9951d0d88
+  metadata.gz: 201c7f4e80d97cc27ec1b94f31ee6840e1d88ee599745b95ebc6ec8c124a266bb30ea052f59b217bc9641714e0190e3433c32f4d1f0d4a7ad4c0691affb4e1cd
+  data.tar.gz: 523da1fd1c4bc4a8451f0a90dc0a0a019dac481b8c9b0ca71debd47ba9014feaf920a63bb1865d4ca4f43bebe576a5f62e8d21d6fd3d6b4179ef6c1e08c43fa8

data/README.md

@@ -1,13 +1,28 @@
 # CrossSpecRails
-Short description and motivation.
+Provides integrations between [cross spec ruby](https://github.com/doximity/cross_spec_ruby) and Rails.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cross_spec_rails'
+```
+
+And then execute:
+```bash
+$ bundle
+```
 
 ## Usage
 Mount the engine in your routes file like
 ```
-mount CrossSpecRails::Engine, at: "/cross_spec"
+if Rails.env.test?
+  mount CrossSpecRails::Engine, at: "/cross_spec"
+end
 ```
 
 ### Requesting factory data over http
+_N.B only FactoryGirl/FactoryBot are supported right now._
 
 ```
 curl -X POST http://localhost:5020/cross_spec/factories/user
@@ -16,7 +31,7 @@ Note the URL namespace from the routes.rb of `cross_spec` followed by the `/fact
 
 You can also specify attributes for the factory using a query string like
 ```
-curl -X POST http://localhost:5020/cross_spec/factories/user?email=julie@example.com&name=Julie
+curl -X POST http://localhost:5020/cross_spec/factories/user?attributes[email]=julie@example.com&attributes[name]=Julie
 ```
 
 Traits are supported as well
@@ -24,24 +39,15 @@ Traits are supported as well
 curl -X POST http://localhost:5020/cross_spec/factories/user?traits[]=admin&traits[]=with_articles
 ```
 
-The data doesn't have to be in the query string it can be part of the request body as well (it uses what is available in the params hash).
-
-
-## Installation
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'cross_spec_rails'
+You can control the response format with `to_json_args`
 ```
+curl -X POST http://localhost:5020/cross_spec/factories/user?to_json_args[include]=articles
 
-And then execute:
-```bash
-$ bundle
-```
+See the [to_json docs](https://apidock.com/rails/ActiveRecord/Serialization/to_json) for supported params.  The object provided in the request is passed directly to that method
 
-Or install it yourself as:
-```bash
-$ gem install cross_spec_rails
+Finally the bulk api is also supported
+```
+curl -X POST http://localhost:5020/cross_spec/factories_list/user?num=4
 ```
 
 ## Contributing

data/app/controllers/cross_spec_rails/factories_controller.rb

@@ -17,26 +17,37 @@ module CrossSpecRails
     skip_before_action :verify_authenticity_token
 
     def create
-      factory = params[:factory]
-      traits = Array(params[:traits]).map(&:to_sym)
-      attributes = params[:attributes]&.permit!.to_h
-      includes = params[:includes]
       instance = factory_klass.create(factory, *traits, attributes)
-      render json: instance.to_json(params[:to_json_args])
+      render json: instance.to_json(to_json_args)
     end
 
     def create_list
-      factory = params[:factory]
-      traits = Array(params[:traits]).map(&:to_sym)
-      attributes = params[:attributes]&.permit!.to_h
-      includes = params[:includes]
-      num = params[:num].to_i
       instances = factory_klass.create_list(factory, num, *traits, attributes)
-      render json: instance.map { |instance| instance.to_json(params[:to_json_args]) }
+      render json: instances.map { |instance| instance.to_json(to_json_args) }
     end
 
     private
 
+    def factory
+      params[:factory]
+    end
+
+    def traits
+      Array(params[:traits]).map(&:to_sym)
+    end
+
+    def attributes
+      params[:attributes]&.permit!.to_h
+    end
+
+    def to_json_args
+      params[:to_json_args]
+    end
+
+    def num
+      params[:num].to_i
+    end
+
     def factory_klass
       return FactoryBot if defined? FactoryBot
       return FactoryGirl if defined? FactoryGirl

data/lib/cross_spec_rails/version.rb

@@ -1,3 +1,3 @@
 module CrossSpecRails
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cross_spec_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Ben Fischer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-21 00:00:00.000000000 Z
+date: 2018-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails