backdrop 0.1.1 → 0.1.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDhkOWEwZWU4YWZiMDMwM2Y3OWZkYWM2NzkyMTY3ODMwNGE2M2FlMg==
+    MWYxYjlkNWEyM2JiNzJlY2EzODA3NWViYTQ0MTE5MDhmNGVmMmZmMw==
   data.tar.gz: !binary |-
-    ZGViM2Y3OWI0MmM0MTA0YmE5YzM2MDRkZjJkNmExMTY3YjY0MDBjNw==
+    ODRjNGZmNmEyOTEzYWFmZTliYmIyZWU3YjdiNjZhY2YzM2EzZWJmOA==
 SHA512:
   metadata.gz: !binary |-
-    NTc0ZGJhY2U5NjE2MzhiMzEwYmFhYTE1ZGUwZTEzYjZiZTU4ZGVhNWUxOTFi
-    OGFhMDFiMDMzZDc5YzRhN2Q0ZGU0YjZmMDU4NjFmNzIzMWJkZWQ3N2EzNjY2
-    ZTA2ZjU0ZTUwOTExNTY4NjZiOTgwNDdjZDE0OTQ4MzdjM2YwNzE=
+    Njc4NmFkZGU2ZTIyMWZlYWQxMDVmYTY4ODliZjlhNjMwY2M3OGQ1NDAyYjYx
+    NmM3Zjc0ZDNjNTEyODE4NGJiOWVjNDkxNDkwNTJmMDg4Y2Q2ODY5ZWY2M2Fj
+    YTA1MGRhOGE0YjhiNWJkZWJhNGUxZDkyOTAxYmM4ODNlMThmYWU=
   data.tar.gz: !binary |-
-    OTA2NzE0NWE0MWNhY2M2NzQwMmI2MmJkMmFlZjRlNGIxMmRjN2E3MjAxNmJi
-    MGYyZGYzZjk0NzI4MTE1OWFlOTJlZjAyNDQ0ODE3ZGJjMjQxMTYzNjI3ZjMy
-    OWIzYzAyZDQxY2E1MmI0YmUzYjA4ZjU2ZjMyZmVmMzkyMzlmMDU=
+    MTRhNDhkZDY5MmVjYWRkZjI4ZWIyYmQ3MDIzMmM1NjY4ZjVkMjBmZGRlOGUy
+    NDRlOTlkOTY5ZDBmMzRhYjZhOTBmNWY0NTRlNDBkOTJlMDVjNTE1OWNiNjk1
+    YTNjM2M2OWExMjM1NDM1YTU1MjI0MjViN2Q0OGQwZWUyOGM1NjE=

data/Gemfile

@@ -3,6 +3,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
+  gem 'byebug'
   gem 'codeclimate-test-reporter', require: false
   gem 'coveralls', require: false
   gem 'rack-test'

data/config.ru

@@ -1,3 +1,3 @@
 require 'backdrop'
 
-Backdrop::App.run
+Backdrop::App.run!

data/lib/backdrop/api_builder.rb

@@ -13,7 +13,17 @@ module Backdrop
       filename = File.basename(file)
       filepath = File.join(@output_dir, project, path)
       FileUtils.mkdir_p filepath
-      File.write("#{File.join(filepath, filename)}.json", response)
+      File.write("#{File.join(filepath, filename)}.get", response)
+    end
+
+    def build_put(project, data)
+      file = data['route']
+      response = data['requests'].first['response_status']
+      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)}.put", response)
     end
   end
 end

data/lib/backdrop/app.rb

@@ -1,22 +1,28 @@
 module Backdrop
   class App < Sinatra::Base
+    SUPPORTED_HTTP_METHODS = [:get, :put]
+
     def initialize(app = nil)
       super app
       self.class.build_routes
     end
 
     def self.build_routes
-      files = Dir["#{Backdrop.configuration.output_dir}/**/*"]
-
-      files.each do |file|
-        route = file.gsub Backdrop.configuration.output_dir, ''
-        route = route.gsub '.json', ''
-
-        get route do
-          content_type :json
-          File.read File.expand_path(file)
+      SUPPORTED_HTTP_METHODS.each do |method|
+        files = Dir["#{Backdrop.configuration.output_dir}/**/*.#{method}"]
+        files.each do |file|
+          route = file.gsub Backdrop.configuration.output_dir, ''
+          route = route.gsub ".#{method}", ''
+          build_route(method, route, file)
         end
       end
     end
+
+    def self.build_route(method, route, file)
+      send(method, route) do
+        builder = Backdrop::Builders.const_get(method.to_s.capitalize).new
+        builder.build(self, file)
+      end
+    end
   end
 end

data/lib/backdrop/builders/get.rb

@@ -0,0 +1,10 @@
+module Backdrop
+  module Builders
+    class Get
+      def build(app, file)
+        app.content_type :json
+        File.read File.expand_path(file)
+      end
+    end
+  end
+end

data/lib/backdrop/builders/put.rb

@@ -0,0 +1,11 @@
+module Backdrop
+  module Builders
+    class Put
+      def build(app, file)
+        app.content_type :json
+        code = File.read File.expand_path(file)
+        app.status code.to_i
+      end
+    end
+  end
+end

data/lib/backdrop/extractor.rb

@@ -17,6 +17,7 @@ module Backdrop
       rad_json.each do |json_file|
         json = JSON.parse File.read(json_file)
         builder.build_get(project, json) if json['http_method'] == 'GET'
+        builder.build_put(project, json) if json['http_method'] == 'PUT'
       end
     end
   end

data/lib/backdrop/version.rb

@@ -1,3 +1,3 @@
 module Backdrop
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/backdrop.rb

@@ -3,6 +3,8 @@ require 'backdrop/version'
 require 'backdrop/configuration'
 require 'backdrop/runner'
 require 'backdrop/extractor'
+require 'backdrop/builders/get'
+require 'backdrop/builders/put'
 require 'backdrop/api_builder'
 require 'backdrop/app'
 

data/spec/backdrop/api_builder_spec.rb

@@ -25,9 +25,30 @@ describe Backdrop::ApiBuilder do
     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"
+        "#{File.join(@output_dir, 'project', sample_api['route'])}.get"
       )
       expect(output).to eq '{"Hello":"World"}'
     end
   end
+
+  describe '#build_put' do
+
+    let(:sample_api) do
+      { 'http_method' => 'PUT',
+        'route' => '/project/request',
+        'requests' => [{
+          'response_body' => nil,
+          'response_status' => 201
+        }] }
+    end
+
+    it 'creates a json file for each request/response pair' do
+      subject.build_put 'project', sample_api
+      output = File.read(
+        "#{File.join(@output_dir, 'project', sample_api['route'])}.put"
+      )
+      expect(output).to eq '201'
+    end
+
+  end
 end

data/spec/backdrop/builders/get_spec.rb

@@ -0,0 +1,22 @@
+require 'backdrop'
+describe Backdrop::Builders::Get do
+  describe '#build' do
+    let(:app) { double :app }
+    let(:file) { Tempfile.new 'file' }
+
+    before do
+      file.write('Hello World')
+      file.rewind
+      allow(app).to receive(:content_type).with(:json)
+    end
+
+    it 'sets the content type to json' do
+      subject.build app, file
+      expect(app).to have_received(:content_type).with :json
+    end
+
+    it 'returns the contents of the file' do
+      expect(subject.build app, file).to eq 'Hello World'
+    end
+  end
+end

data/spec/backdrop/builders/put_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'backdrop'
+
+describe Backdrop::Builders::Put do
+  describe '#build' do
+    let(:app) { double :app }
+    let(:file) { Tempfile.new 'file' }
+
+    before do
+      file.write(200)
+      file.rewind
+      allow(app).to receive(:content_type).with(:json)
+      allow(app).to receive(:status).with 200
+    end
+    it 'sets the content type to json' do
+      subject.build app, file
+      expect(app).to have_received(:content_type).with(:json)
+    end
+
+    it 'sets the status code to the contents of file' do
+      subject.build app, file
+      expect(app).to have_received(:status).with 200
+    end
+  end
+end

data/spec/backdrop/extractor_spec.rb

@@ -24,20 +24,40 @@ describe Backdrop::Extractor do
 
   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
+      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
+
       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
+
+    context 'when the request is a PUT' do
+      let(:json) { { 'http_method' => 'PUT' } }
+
+      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
+
+      it 'creates an API for each post request' do
+        expect(api_builder).to receive(:build_put).with('project', json)
+        subject.build_apis 'project', [@json_file.path], 'output'
+      end
+    end
   end
 
   describe '#load_docs' do

data/spec/integration/backdrop_spec.rb

@@ -3,46 +3,69 @@ require 'backdrop'
 require 'tmpdir'
 require 'rack/test'
 
-describe 'Backdrop' do
+describe 'Backdrop POST' do
   include Rack::Test::Methods
-  let!(:test_dir) { Dir.mktmpdir }
+
+  before(:all) do
+    @test_dir = Dir.mktmpdir
+  end
+
+  after(:all) do
+    FileUtils.remove_entry_secure @test_dir
+  end
   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(:output_path) { File.join(@test_dir, 'output') }
+  let(:project_path) { File.join(@test_dir, 'project') }
 
   def app
     Backdrop.configure do |config|
-      config.output_dir = File.join(test_dir, 'output')
+      config.output_dir = output_path
     end
     Backdrop::App
   end
 
-  describe 'running backdrop with an out directory and API project' do
-    let(:rad_output) do
+  describe 'running with an out directory and API project' do
+    let(:put_output) do
+      { 'http_method' => 'PUT',
+        'route' => 'resource/put_request',
+        'requests' => [{
+          'response_body' => nil,
+          'response_status' => 201
+        }] }
+    end
+
+    let(:get_output) do
       { 'http_method' => 'GET',
-        'route' => '/resource/request',
+        'route' => '/resource/get_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)
+        File.join(project_path, '/doc/api/put_request.json'),
+        JSON.generate(put_output)
+      )
+      File.write(
+        File.join(project_path, '/doc/api/get_request.json'),
+        JSON.generate(get_output)
       )
       subject.run
     end
 
-    after do
-      FileUtils.remove_entry_secure test_dir
+    context 'when the method is PUT' do
+      it 'responds with the correct status' do
+        put '/project/resource/put_request'
+        expect(last_response.status).to eq 201
+      end
     end
 
-    it 'creates the APIs in the target directory' do
-      get '/project/resource/request'
-      expect(last_response.body).to eq '{"Hello":"World"}'
+    context 'when the method is GET' do
+      it 'responds with the response body' do
+        get '/project/resource/get_request'
+        expect(last_response.body).to eq '{"Hello":"World"}'
+      end
     end
   end
-
 end

data/spec/spec_helper.rb

@@ -21,3 +21,21 @@ SimpleCov.start do
   add_filter 'vendor'
   add_filter 'spec'
 end
+
+RSpec.configure do |config|
+
+  config.default_formatter = 'doc' if config.files_to_run.one?
+
+  config.order = :random
+
+  Kernel.srand config.seed
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: backdrop
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Tom Bowden
@@ -59,6 +59,8 @@ files:
 - lib/backdrop.rb
 - lib/backdrop/api_builder.rb
 - lib/backdrop/app.rb
+- lib/backdrop/builders/get.rb
+- lib/backdrop/builders/put.rb
 - lib/backdrop/configuration.rb
 - lib/backdrop/extractor.rb
 - lib/backdrop/rake_task.rb
@@ -67,6 +69,8 @@ files:
 - lib/tasks/default.rake
 - lib/tasks/rubocop.rake
 - spec/backdrop/api_builder_spec.rb
+- spec/backdrop/builders/get_spec.rb
+- spec/backdrop/builders/put_spec.rb
 - spec/backdrop/configuration_spec.rb
 - spec/backdrop/extractor_spec.rb
 - spec/backdrop/runner_spec.rb