backdrop 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03e8c9bdd322c60e34a4f1d3fe5f1173d47b3ae2
-  data.tar.gz: 0dd41d8928c2280cf52c318d15b4050f7b01f5da
+  metadata.gz: a475e27a7d3fc87705af139f517a6e00ed727e9f
+  data.tar.gz: 6ec0698f911273e27b9075256a54e2b572f16ce2
 SHA512:
-  metadata.gz: 89a5dc5b3ed5b7842cc432c2b5ccb0315f4f1f69f2cfd62f8cde0905984246757b5d970a852750563484aabcd1d684cda8c3e7345371b8f9f6a45f8736adca03
-  data.tar.gz: 29fd2c92f71ecb53bd0ec838ef8e02a809bbfa083e1cb98fe8a7865e3a11efc4756d21a1d286040adb002cc75e800081712268fd72de6da6134e320ba4858402
+  metadata.gz: b2aad5ee00d310efbd1f987aa1f9a8dbd5057248e6ae11c43c138eb894e1e56b8b1e68d20d297951803e440f89c3cba330253a212298406ff53d7aaf462ced7d
+  data.tar.gz: 046999fe5ae52cdc7a5ba1bf300e326c5a2f3e1576dcde5f05cdad7f6a8aac1245a355555e8f6d1769ae93bdefe8c6619e583cb998d3de5e249a3cd5c847e4f3

data/.gitignore

@@ -0,0 +1,9 @@
+fixtures
+*.swp
+*.gem
+Gemfile.lock
+.rvmrc
+lib/tasks/fixtures.rake
+/tmp
+/log
+/doc

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Documentation:
+  Enabled: false
+AllCops:
+  Exclude:
+    - 'vendor/**/*'

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create ruby-2.1.2@backdrop

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+branches:
+  only:
+  - master
+rvm:
+- 2.1.2
+- 2.0.0
+script:
+- bundle exec rake

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rake_rack'
+  gem 'rspec'
+  gem 'rubocop'
+  gem 'simplecov', require: false
+end

data/README.md

@@ -0,0 +1,40 @@
+Backdrop [![Code Climate](https://codeclimate.com/github/tpbowden/Backdrop/badges/gpa.svg)](https://codeclimate.com/github/tpbowden/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) [![Dependency Status](https://gemnasium.com/tpbowden/Backdrop.svg)](https://gemnasium.com/tpbowden/Backdrop)
+========
+
+Detects all APIs required and generates stubs based on RAD documentation
+
+Installation
+------------
+
+Gemfile
+
+    gem 'backdrop'
+
+config/routes.rb
+
+    mount Backdrop::App => '/backdrop'
+
+Ensure your APIs are generating JSON docs
+
+    RspecApiDocumentation.configure do |config|
+      config.format = :json
+    end
+
+
+Generating Stubs
+----------------
+
+Create a rake task with an array of paths to your API projects
+
+lib/tasks/backdrop.rake
+
+    require 'backdrop/rake_task'
+
+    Backdrop::RakeTask.new('output_directory', ['/paths/to/projects'])
+
+Call `rake backdrop` to create all RAD APIs in the specified output directory
+
+Dependencies
+============
+
+* Ruby >= 2.0.0

data/Rakefile

@@ -0,0 +1 @@
+Dir.glob('lib/tasks/*.rake').each { |task| import task }

data/backdrop.gemspec

@@ -0,0 +1,16 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'backdrop/version'
+
+Gem::Specification.new do |s|
+  s.name         = 'backdrop'
+  s.version      = Backdrop::VERSION
+  s.date         = '2014-09-16'
+  s.summary      = 'Fixture generation using RAD'
+  s.description  = 'Fixture generation using RAD'
+  s.authors      = ['Tom Bowden', 'Richard Vickerstaff', 'Adam Whittingham']
+  s.files        = `git ls-files`.split($/)
+  s.homepage     = 'http://github.com/tpbowden/backdrop'
+  s.license      = 'MIT'
+  s.add_dependency 'sinatra', '~> 1.4'
+  s.add_dependency 'rake', '~> 10.1'
+end

data/config.ru

@@ -0,0 +1,2 @@
+require './sonar'
+run Sonar

data/lib/backdrop/api_builder.rb

@@ -0,0 +1,19 @@
+require 'json'
+
+module Backdrop
+  class ApiBuilder
+    def initialize(output_dir)
+      @output_dir = output_dir
+    end
+
+    def build_get(project, data)
+      file = data['route']
+      response = data['requests'].first['response_body']
+      path = File.dirname(file)
+      filename = File.basename(file)
+      filepath = File.join(@output_dir, project, path)
+      FileUtils.mkdir_p filepath
+      File.write("#{File.join(filepath, filename)}.json", response)
+    end
+  end
+end

data/lib/backdrop/app.rb

@@ -0,0 +1,17 @@
+require 'sinatra/base'
+
+module Backdrop
+  class App < Sinatra::Base
+    files = Dir['fixtures/**/*']
+
+    files.each do |file|
+      route = file.gsub 'fixtures', ''
+      route = route.gsub '.json', ''
+
+      get "#{route}" do
+        content_type :json
+        File.read File.expand_path(file)
+      end
+    end
+  end
+end

data/lib/backdrop/extractor.rb

@@ -0,0 +1,24 @@
+require 'json'
+require 'backdrop/api_builder'
+
+module Backdrop
+  class Extractor
+    def project_name(path)
+      path.gsub('/workspace', '').match(/\/(\w+)$/).captures.first
+    end
+
+    def load_docs(project_path)
+      docs_dir = File.join(File.expand_path(project_path), 'doc/api')
+      Dir["#{docs_dir}/**/*.json"]
+        .reject { |filename| filename =~ /index\.json$/ }
+    end
+
+    def build_apis(project, rad_json, output_dir)
+      builder = Backdrop::ApiBuilder.new output_dir
+      rad_json.each do |json_file|
+        json = JSON.parse File.read(json_file)
+        builder.build_get(project, json) if json['http_method'] == 'GET'
+      end
+    end
+  end
+end

data/lib/backdrop/rake_task.rb

@@ -0,0 +1,14 @@
+require 'rake'
+require 'rake/tasklib'
+require 'backdrop/runner'
+
+module Backdrop
+  class RakeTask < Rake::TaskLib
+    def initialize(output_dir, projects)
+      desc 'Run backdrop'
+      task :backdrop do
+        Backdrop::Runner.new(output_dir, projects).run
+      end
+    end
+  end
+end

data/lib/backdrop/runner.rb

@@ -0,0 +1,20 @@
+require 'backdrop/extractor'
+
+module Backdrop
+  class Runner
+    def initialize(output_dir, projects)
+      @projects = projects
+      @output_dir = output_dir
+    end
+
+    def run
+      FileUtils.rm_rf @output_dir
+      extractor = Backdrop::Extractor.new
+      @projects.each do |project_path|
+        project_name = extractor.project_name(project_path)
+        json_to_emulate = extractor.load_docs(project_path)
+        extractor.build_apis project_name, json_to_emulate, @output_dir
+      end
+    end
+  end
+end

data/lib/backdrop/version.rb

@@ -0,0 +1,3 @@
+module Backdrop
+  VERSION = '0.0.9'
+end

data/lib/backdrop.rb

@@ -1,4 +1 @@
 require 'backdrop/app'
-
-dir = File.expand_path('./tasks', File.dirname(__FILE__))
-Dir.glob("#{dir}/backdrop.rake").each { |r| import r }

data/lib/tasks/default.rake

@@ -0,0 +1,8 @@
+require 'rake_rack'
+
+task default: [
+  :rubocop,
+  :"rake_rack:rspec",
+  :"rake_rack:coverage:check_specs",
+  :"rake_rack:ok_rainbow"
+]

data/lib/tasks/rubocop.rake

@@ -0,0 +1,3 @@
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new

data/spec/backdrop/api_builder_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require 'backdrop/api_builder'
+require 'tmpdir'
+
+describe Backdrop::ApiBuilder do
+  before do
+    @output_dir = Dir.mktmpdir('output')
+  end
+
+  after do
+    FileUtils.remove_entry_secure @output_dir
+  end
+
+  let(:subject) { Backdrop::ApiBuilder.new(@output_dir) }
+  describe '#build_get' do
+
+    let(:sample_api) do
+      { 'http_method' => 'GET',
+        'route' => '/project/request',
+        'requests' => [{
+          'response_body' => '{"Hello":"World"}'
+        }] }
+    end
+
+    it 'creates a json file for each request/response pair' do
+      subject.build_get 'project', sample_api
+      output = File.read(
+        "#{File.join(@output_dir, 'project', sample_api['route'])}.json"
+      )
+      expect(output).to eq '{"Hello":"World"}'
+    end
+  end
+end

data/spec/backdrop/extractor_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+require 'backdrop/extractor'
+require 'backdrop/api_builder'
+require 'tmpdir'
+require 'tempfile'
+
+describe Backdrop::Extractor do
+
+  describe '#project_name' do
+    context 'when running a normal project' do
+      let(:file_path) { '/files/projects/name' }
+
+      it 'works out the project name based on its path' do
+        expect(subject.project_name(file_path)).to eq 'name'
+      end
+    end
+
+    context 'when running a project on Jenkins' do
+      let(:file_path) { '/files/projects/jenkins_project/workspace' }
+      it 'strips workspace/ from the path (for Jenkins builds)' do
+        expect(subject.project_name(file_path)).to eq 'jenkins_project'
+      end
+    end
+  end
+
+  describe '#build_apis' do
+    let(:api_builder) { double :api_builder }
+    let(:json) { { 'http_method' => 'GET' } }
+    before do
+      allow(Backdrop::ApiBuilder).to receive(:new).with('output')
+        .and_return api_builder
+      @json_file = Tempfile.new 'file.json'
+      @json_file.write(JSON.generate json)
+      @json_file.rewind
+    end
+    context 'when the request is a GET' do
+      it 'creates an API for each get request' do
+        expect(api_builder).to receive(:build_get).with('project', json)
+        subject.build_apis 'project', [@json_file.path], 'output'
+      end
+    end
+  end
+
+  describe '#load_docs' do
+    before do
+      @dir = Dir.mktmpdir
+      FileUtils.mkdir_p("#{@dir}/doc/api")
+      File.write("#{@dir}/doc/api/index.json", '{"hello":"world"}')
+      File.write("#{@dir}/doc/api/api.json", '{"json":"api"}')
+    end
+
+    after do
+      FileUtils.remove_entry_secure @dir
+    end
+
+    it 'loads the files but excludes the index.json' do
+      expect(subject.load_docs(@dir)).to match_array([
+        "#{@dir}/doc/api/api.json"
+      ])
+    end
+  end
+end

data/spec/backdrop/runner_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'backdrop/extractor'
+require 'backdrop/runner'
+
+describe Backdrop::Runner do
+
+  let(:output_dir) { '/fixtures' }
+  let(:project_paths) { ['/project/path'] }
+  let(:project_name) { 'path' }
+  let(:rad_docs) { ['file.json'] }
+  let(:subject) { Backdrop::Runner.new(output_dir, project_paths) }
+
+  describe '#run' do
+    let(:extractor) do
+      double :extractor, project_name: project_name, load_docs: rad_docs
+    end
+    let(:builder) { double :builder }
+
+    before do
+      allow(Backdrop::Extractor).to receive(:new).and_return extractor
+    end
+
+    it 'works out the project name' do
+      expect(extractor).to receive(:build_apis).with(
+        project_name,
+        rad_docs,
+        output_dir
+      )
+      subject.run
+    end
+  end
+end

data/spec/integration/backdrop_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'backdrop/runner'
+require 'tmpdir'
+
+describe 'Backdrop' do
+
+  describe 'running backdrop with an out directory and API project' do
+    let!(:test_dir) { Dir.mktmpdir }
+    let(:subject) { Backdrop::Runner.new(output_path, [project_path]) }
+    let(:output_path) { File.join(test_dir, 'output') }
+    let(:project_path) { File.join(test_dir, 'project') }
+    let(:rad_output) do
+      { 'http_method' => 'GET',
+        'route' => '/resource/request',
+        'requests' => [{
+          'response_body' => '{"Hello":"World"}'
+        }] }
+    end
+
+    before do
+      FileUtils.mkdir_p(File.join(project_path, 'doc/api/resource'))
+      File.write(
+        File.join(project_path, '/doc/api/request.json'),
+        JSON.generate(rad_output)
+      )
+    end
+
+    after do
+      FileUtils.remove_entry_secure test_dir
+    end
+
+    it 'creates the APIs in the target directory' do
+      subject.run
+      out = (File.read(File.join(output_path, 'project/resource/request.json')))
+      expect(out).to eq '{"Hello":"World"}'
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'simplecov'
+
+SimpleCov.coverage_dir 'log/coverage/rspec'
+SimpleCov.start do
+  add_filter 'vendor'
+  add_filter 'spec'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: backdrop
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Tom Bowden
@@ -46,8 +46,30 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rvmrc"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- backdrop.gemspec
+- config.ru
 - lib/backdrop.rb
-- lib/tasks/backdrop.rake
+- lib/backdrop/api_builder.rb
+- lib/backdrop/app.rb
+- lib/backdrop/extractor.rb
+- lib/backdrop/rake_task.rb
+- lib/backdrop/runner.rb
+- lib/backdrop/version.rb
+- lib/tasks/default.rake
+- lib/tasks/rubocop.rake
+- spec/backdrop/api_builder_spec.rb
+- spec/backdrop/extractor_spec.rb
+- spec/backdrop/runner_spec.rb
+- spec/integration/backdrop_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/tpbowden/backdrop
 licenses:
 - MIT

data/lib/tasks/backdrop.rake

@@ -1,9 +0,0 @@
-require 'json'
-require 'backdrop/runner'
-
-namespace :backdrop do
-  desc 'Loads all paths to RAD docs and creates the stub APIs'
-  task :update_fixtures do
-    Backdrop::Runner.new(@backdrop_output_dir, @backdrop_api_projects).run
-  end
-end