backdrop 0.3.0 → 0.3.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    M2MzZjUzNDNkMmVhNGUxMTlhNDAyNzYwOGJlZjVlMzk1N2M5MTQ0NQ==
+    N2Y4MDRhNmQzZTQwOGFkNjM5YzVmNTFhOTkxNTZmYzQ3YWYxNjZmNw==
   data.tar.gz: !binary |-
-    YmViMmI4NTBiZGYxM2U0NGJmMzkwZDBkZmM0NWFkZTgwZTU4MGQxZg==
+    ZjU3YmZkOWQ5MWVlY2YxOWM0OWIzM2EyYTY3ZDcxZDY4MzlhZjczNQ==
 SHA512:
   metadata.gz: !binary |-
-    OTAxMDAwODMzZDVmNDFjMmVlYmU1ZmEwNThjYjdhM2MwZWNiNWU5MGJkZjk2
-    MWE4NGU5YmI1NDE4OWIwMThjZTgxZGI5OWZkZTI1MzM1M2EwNmFkYjNmNWJm
-    MzRiMTYzZDhhNDIwZDhhODYwZWJiMDZkOTc4MzIzYWNlNmJlNTU=
+    NjY2NGNkODVlYmE0ZGE0ODAzYTliY2EyZTlhZmQ5YjI3MTEwZmI1MTg0OGVi
+    OWIyNzBlZmZjNzg5MTAzMTViZGEwN2RlNjRmNTFmODYwMDA1OTNjNTc4ZjA1
+    NmI2NTI4Y2VhYTY0ZmFkNGU2Y2MxYmM1MzE0ZWY1MmYxNWY0OGE=
   data.tar.gz: !binary |-
-    MDAxYmMxM2MzYmYwOTIwNDY3ZWY4NmQ4YWJkZGYwYjk5N2MyYzhhNWVkODUx
-    YjJkN2U1MzEzYTMyMzkxYmUwZjQ2YzhjYmYxM2Y5MjU4ZGRlNGQ3OGE0Yjk0
-    MTJkYmFjZDNlOWMzYTg4NjVmYWI4M2M1ZDc1MGFhMWUxYjc1ZWE=
+    NzU4OTY3NGY1YzgxZTg2YzgxN2FkZThlNmEzY2E2ZmQ3Y2YyZjZkMmJlMTc5
+    MGZjMjVlNmFiOTkxZGU2ZDdiZjNmNzdlMDUyOGY0ZDJiZjgyOTA4YTI5MTlh
+    NDRmMTU3MWViMzRjNmM1MDYxNGE0NzUxOWYwZDQ4ZjQzMGEyMDY=

data/.gitignore

@@ -8,3 +8,4 @@ lib/tasks/fixtures.rake
 /log
 /doc
 *.orig
+/tmp

data/.travis.yml

@@ -6,6 +6,9 @@ branches:
 env:
   global:
   - CODECLIMATE_REPO_TOKEN=a79c2033f8bd8de4442fbffdee847be7f8a505408ef40350ac598264d2fe2ccc
+os:
+  - linux
+  - osx
 rvm:
 - 2.1.4
 - 2.0.0

data/README.md

@@ -1,9 +1,9 @@
-Backdrop 
+Backdrop
 ========
 
 [![Gem Version](https://badge.fury.io/rb/backdrop.svg)](http://badge.fury.io/rb/backdrop) [![Build Status](https://travis-ci.org/tpbowden/backdrop.svg?branch=master)](https://travis-ci.org/tpbowden/backdrop) [![Coverage Status](https://img.shields.io/coveralls/tpbowden/backdrop.svg)](https://coveralls.io/r/tpbowden/backdrop?branch=master) [![Code Climate](https://codeclimate.com/github/tpbowden/backdrop/badges/gpa.svg)](https://codeclimate.com/github/tpbowden/backdrop) [![Dependency Status](https://gemnasium.com/tpbowden/Backdrop.svg)](https://gemnasium.com/tpbowden/Backdrop)
 
-Detects all APIs required and generates stubs based on RAD documentation
+JSON fixture generation for integration testing apps which consume multiple remote APIs.
 
 Installation
 ------------
@@ -16,33 +16,45 @@ config/routes.rb
 
     mount Backdrop::App => '/backdrop'
 
-Ensure your APIs are generating JSON docs
-
-    RspecApiDocumentation.configure do |config|
-      config.format = :json
-    end
-
 Configuration
 -------------
 
-config/initializers/backdrop_init.rb
+Backdrop stores JSON in temporary files whilst it runs which should not be checked into version control. This can be specificied in an initializer:
 
     Backdrop.configure do |config|
-      config.output_dir = 'output_directory'
+      # defaults to tmp/backdrop
+      config.output_dir = '/your/temp/path'
     end
 
-Generating Stubs
-----------------
+Usage
+-----
+
+    require 'backdrop'
+
+Backdrop can be used on either a single OpenStruct or an array of OpenStructs. Each of these must have a property called 'backdrop_url' which is where the generated JSON will be located. This will be removed before being used for the API.
+
+To create an API, call `Backdrop.load` on the data. To clear all loaded APIs, use `Backdrop.clear`.
+
+Integration with Factory Girl
+-----------------------------
+
+Backdrop is most easily used alongside [FactoryGirl](https://github.com/thoughtbot/factory_girl).
+
+    FactoryGirl.define do
+      factory :example, class: OpenStruct do
+        backdrop_url { name }
+        name "example"
+      end
+    end
 
-Create a rake task with an array of paths to your API projects
+You can then use `Backdrop.load(FactoryGirl.build :example)` to create the following JSON at `/backdrop/example`:
 
-lib/tasks/backdrop.rake
+    `{"name":"example"}`
 
-    require 'backdrop/rake_task'
+Similarly, `Backdrop.load(FactoryGirl.build_list :example, 2)` would create the following JSON:
 
-    Backdrop::RakeTask.new('output_directory', ['/paths/to/projects'])
+    [{"name":"example"},{"name":"example"}]
 
-Call `rake backdrop` to create all RAD APIs in the specified output directory
 
 Dependencies
 ------------

data/lib/backdrop/api_builder.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+require 'backdrop'
 require 'backdrop/app'
 
 module Backdrop
@@ -18,12 +20,18 @@ module Backdrop
         url = record.delete_field 'backdrop_url'
         record.to_h
       end
-      Backdrop::App.load_api(url, JSON.generate(formatted_data))
+      write_api(url, JSON.generate(formatted_data))
     end
 
     def build_single(input)
       url = input.delete_field('backdrop_url')
-      Backdrop::App.load_api(url, JSON.generate(input.to_h))
+      write_api(url, JSON.generate(input.to_h))
+    end
+
+    def write_api(url, json)
+      file = "#{File.join(Backdrop.configuration.output_dir, url)}.json"
+      FileUtils.mkdir_p(File.dirname(file))
+      File.write(file, json)
     end
   end
 end

data/lib/backdrop/app.rb

@@ -2,9 +2,16 @@ require 'sinatra'
 
 module Backdrop
   class App < Sinatra::Base
-    def self.load_api(url, data)
-      get url do
-        data
+    get '/*' do
+      file = File.join(
+        Backdrop.configuration.output_dir,
+        "#{params[:splat].first}.json"
+      )
+      if File.exist? file
+        status 200
+        File.read file
+      else
+        status 404
       end
     end
   end

data/lib/backdrop/configuration.rb

@@ -1,4 +1,9 @@
 module Backdrop
   class Configuration
+    attr_accessor :output_dir
+
+    def initialize
+      @output_dir = 'tmp/backdrop'
+    end
   end
 end

data/lib/backdrop/version.rb

@@ -1,3 +1,3 @@
 module Backdrop
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/spec/backdrop/api_builder_spec.rb

@@ -4,13 +4,14 @@ require 'backdrop/api_builder'
 describe Backdrop::APIBuilder do
   describe '#build' do
     let(:url) { '/some/location' }
+    let(:output_file) { 'tmp/backdrop/some/location.json' }
 
     context 'when the input is a single item' do
       let(:sample_input) { build :example, backdrop_url: url }
       let(:json) { '{"some":"data"}' }
-      it 'tells the server to load the API' do
-        expect(Backdrop::App).to receive(:load_api).with url, json
+      it 'writes a file at the URL path containing the json' do
         subject.build sample_input
+        expect(File.read(output_file)).to eq json
       end
     end
 
@@ -18,8 +19,8 @@ describe Backdrop::APIBuilder do
       let(:sample_input) { build_list :example, 2, backdrop_url: url }
       let(:json) { '[{"some":"data"},{"some":"data"}]' }
       it 'tells the server to load the API array' do
-        expect(Backdrop::App).to receive(:load_api).with url, json
         subject.build sample_input
+        expect(File.read(output_file)).to eq json
       end
     end
   end

data/spec/integration/backdrop_end_to_end_spec.rb

@@ -10,7 +10,6 @@ describe Backdrop do
   end
 
   before do
-    Backdrop.clear
     Backdrop.load sample_factory_data
   end
 
@@ -31,4 +30,12 @@ describe Backdrop do
       expect(last_response.body).to eq '[{"some":"data"},{"some":"data"}]'
     end
   end
+
+  context 'when there is no data for a route' do
+    let(:sample_factory_data) { build :example }
+    it 'gives status 404' do
+      get '/nothing'
+      expect(last_response.status).to eq 404
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: backdrop
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Tom Bowden