apiculture 0.0.18 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0376c2d819d808e7c8857d3eb6eeea9bc057c7d
-  data.tar.gz: 52015f4360aa39a19c0a037f978568ac793a00c7
+  metadata.gz: b6f0c8bf33ab6d850b0e5ebe4137248b2eece90b
+  data.tar.gz: ff2545d4a6b2d335670722f52052b3081976afb6
 SHA512:
-  metadata.gz: '09068eb0cca7bb8d66806bd501220921418d8a7dc02d5e82f8570f18e3014f6b1c0c929bab30c15118b90b7c3534f4226e66c1eb36ebd6b415208d93cfefbead'
-  data.tar.gz: f6d7f01b4d95527ca815e1eeaccfbc4e19d28ae6dc8aeaa1281fe50f14166d66bb7895081bb2f4c993d75483dcd5ff8e914f72756b4691f1a2e82b0bcd36f1b6
+  metadata.gz: 0cd7c2561d5d0139893fbfc78c58e46ee889c84e91756f51773d1000ce4a94b8c5e1af3d2cf0c997835dfc35d6de2fdbaff9b65cece17c3c9835f31915349126
+  data.tar.gz: 2870ec784e365047cf7c737bec1510b98e19fb3efa1d5fbb6c3b3cecabdf78aaa09fea584d3a83abca63ffd99d190831a46867b1ee36c397a9eb275bc3b85bf4

data/.gitignore

@@ -0,0 +1,50 @@
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+Gemfile.lock
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/.travis.yml

@@ -1,6 +1,10 @@
 rvm:
 - 2.1.5
 - 2.2.2
-- 2.3.0
+- 2.3.3
+- 2.4.1
 sudo: false
 cache: bundler
+matrix:
+  allow_failures:
+    - rvm: 2.1.5 # incompatible with the new jeweler version

data/Gemfile

@@ -1,15 +1,4 @@
-source "http://rubygems.org"
-gem 'sinatra', '~> 1.4', :require => 'sinatra/base'
-gem 'builder', '~> 3'
-gem 'rdiscount', '~> 2.1'
-gem 'github-markup', '~> 1'
-gem "mustache", '~> 1'
+source 'https://rubygems.org'
 
-group :development do
-  gem 'rack-test', '~> 0.6'
-  gem "rspec", "~> 3.1", '< 3.2'
-  gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.0"
-  gem "jeweler", "~> 2"
-  gem "simplecov", ">= 0"
-end
+# Source from the gemspec
+gemspec

data/Rakefile

@@ -1,45 +1,5 @@
-# encoding: utf-8
-
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require_relative 'lib/apiculture/version'
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  gem.name = "apiculture"
-  gem.version = Apiculture::VERSION
-  gem.homepage = "https://github.com/WeTransfer/apiculture"
-  gem.license = "MIT"
-  gem.description = %Q{A toolkit for building REST APIs on top of Sinatra}
-  gem.summary = %Q{Sweet API sauce on top of Sintra}
-  gem.email = "me@julik.nl"
-  gem.authors = ["Julik Tarkhanov", "WeTransfer"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rspec/core'
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
-task :default => :spec
-
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "apiculture #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/apiculture.gemspec

@@ -1,91 +1,48 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: apiculture 0.0.18 ruby lib
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'apiculture/version'
 
 Gem::Specification.new do |s|
   s.name = "apiculture"
-  s.version = "0.0.18"
+  s.version = Apiculture::VERSION
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Julik Tarkhanov", "WeTransfer"]
-  s.date = "2016-11-25"
+  s.homepage       = 'http://github.com/wetransfer/zip_tricks'
   s.description = "A toolkit for building REST APIs on top of Sinatra"
   s.email = "me@julik.nl"
+
+  # Prevent pushing this gem to RubyGems.org.
+  # To allow pushes either set the 'allowed_push_host'
+  # To allow pushing to a single host or delete this section to allow pushing to any host.
+  if s.respond_to?(:metadata)
+    s.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+  
+  s.files = `git ls-files -z`.split("\x0")
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md"
   ]
-  s.files = [
-    ".travis.yml",
-    "Gemfile",
-    "LICENSE.txt",
-    "README.md",
-    "Rakefile",
-    "apiculture.gemspec",
-    "lib/apiculture.rb",
-    "lib/apiculture/action.rb",
-    "lib/apiculture/action_definition.rb",
-    "lib/apiculture/app_documentation.rb",
-    "lib/apiculture/app_documentation_tpl.mustache",
-    "lib/apiculture/markdown_segment.rb",
-    "lib/apiculture/method_documentation.rb",
-    "lib/apiculture/sinatra_instance_methods.rb",
-    "lib/apiculture/timestamp_promise.rb",
-    "lib/apiculture/version.rb",
-    "spec/apiculture/action_spec.rb",
-    "spec/apiculture/app_documentation_spec.rb",
-    "spec/apiculture/method_documentation_spec.rb",
-    "spec/apiculture_spec.rb",
-    "spec/spec_helper.rb"
-  ]
   s.homepage = "https://github.com/WeTransfer/apiculture"
   s.licenses = ["MIT"]
   s.rubygems_version = "2.4.5.1"
   s.summary = "Sweet API sauce on top of Sintra"
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
+  s.add_runtime_dependency 'sinatra', '~> 1'
+  s.add_runtime_dependency 'builder', '~> 3'
+  s.add_runtime_dependency 'rdiscount', '~> 2'
+  s.add_runtime_dependency 'github-markup', '~> 1'
+  s.add_runtime_dependency "mustache", '~> 1'
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<sinatra>, ["~> 1.4"])
-      s.add_runtime_dependency(%q<builder>, ["~> 3"])
-      s.add_runtime_dependency(%q<rdiscount>, ["~> 2.1"])
-      s.add_runtime_dependency(%q<github-markup>, ["~> 1"])
-      s.add_runtime_dependency(%q<mustache>, ["~> 1"])
-      s.add_development_dependency(%q<rack-test>, ["~> 0.6"])
-      s.add_development_dependency(%q<rspec>, ["< 3.2", "~> 3.1"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 2"])
-      s.add_development_dependency(%q<simplecov>, [">= 0"])
-    else
-      s.add_dependency(%q<sinatra>, ["~> 1.4"])
-      s.add_dependency(%q<builder>, ["~> 3"])
-      s.add_dependency(%q<rdiscount>, ["~> 2.1"])
-      s.add_dependency(%q<github-markup>, ["~> 1"])
-      s.add_dependency(%q<mustache>, ["~> 1"])
-      s.add_dependency(%q<rack-test>, ["~> 0.6"])
-      s.add_dependency(%q<rspec>, ["< 3.2", "~> 3.1"])
-      s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_dependency(%q<jeweler>, ["~> 2"])
-      s.add_dependency(%q<simplecov>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<sinatra>, ["~> 1.4"])
-    s.add_dependency(%q<builder>, ["~> 3"])
-    s.add_dependency(%q<rdiscount>, ["~> 2.1"])
-    s.add_dependency(%q<github-markup>, ["~> 1"])
-    s.add_dependency(%q<mustache>, ["~> 1"])
-    s.add_dependency(%q<rack-test>, ["~> 0.6"])
-    s.add_dependency(%q<rspec>, ["< 3.2", "~> 3.1"])
-    s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<bundler>, ["~> 1.0"])
-    s.add_dependency(%q<jeweler>, ["~> 2"])
-    s.add_dependency(%q<simplecov>, [">= 0"])
-  end
+  s.add_development_dependency 'rack-test'
+  s.add_development_dependency "rspec", "~> 3.1", '< 3.2'
+  s.add_development_dependency "rdoc", "~> 3.12"
+  s.add_development_dependency "rake", "~> 10"
+  s.add_development_dependency "bundler", "~> 1.0"
+  s.add_development_dependency "simplecov", ">= 0"
 end
-

data/lib/apiculture/sinatra_instance_methods.rb

@@ -28,11 +28,11 @@ module Apiculture::SinatraInstanceMethods
   # given in the keyword arguments
   def action_result(action_class, **action_ivars)
     call_result = action_class.new(self, **action_ivars).perform
-  
-    unless call_result.is_a?(Array) || call_result.is_a?(Hash)
-      raise "Action result should be an Array or a Hash, but was a #{call_result.class}"
+
+    unless call_result.is_a?(Array) || call_result.is_a?(Hash) || (call_result.nil? && status == 204)
+      raise "Action result should be an Array, a Hash or it can be nil but only if status is 204, instead it was a #{call_result.class}"
     end
   
-    json_response call_result
+    json_response call_result if call_result
   end
 end

data/lib/apiculture/version.rb

@@ -1,3 +1,3 @@
 module Apiculture
-  VERSION = '0.0.18'
+  VERSION = '0.0.19'
 end

data/spec/apiculture/app_documentation_spec.rb

@@ -29,7 +29,7 @@ describe "Apiculture.api_documentation" do
       end
 
       desc 'Pancake ingredients are in the URL'
-      route_param :topping_id, 'Pancake topping ID', Fixnum, cast: :to_i
+      route_param :topping_id, 'Pancake topping ID', Integer, cast: :to_i
       api_method :get, '/pancake/with/:topping_id' do |topping_id|
       end
     end

data/spec/apiculture/method_documentation_spec.rb

@@ -68,7 +68,7 @@ describe Apiculture::MethodDocumentation do
     
     definition.description = "This adds a topping to a pancake"
     
-    definition.route_parameters << Apiculture::RouteParameter.new(:topping_id, 'ID of the pancake topping', Fixnum, cast: :to_i)
+    definition.route_parameters << Apiculture::RouteParameter.new(:topping_id, 'ID of the pancake topping', Integer, cast: :to_i)
     definition.http_verb = 'get'
     definition.path = '/pancake/:topping_id'
     

data/spec/apiculture_spec.rb

@@ -319,9 +319,9 @@ describe "Apiculture" do
         settings.raise_errors = true
         extend Apiculture
       
-        route_param :number, "Number of the thing", Fixnum, :cast => :to_i
+        route_param :number, "Number of the thing", Integer, :cast => :to_i
         api_method :post, '/thing/:number' do |number|
-          raise "Not cast" unless number.class == Fixnum
+          raise "Not cast" unless number.class == Integer
           'Total success'
         end
       end
@@ -337,7 +337,7 @@ describe "Apiculture" do
         extend Apiculture
       
         param :number, "Number of the thing", Integer, :cast => :to_i
-        route_param :id, "Id of the thingy", Fixnum, :cast => :to_i
+        route_param :id, "Id of the thingy", Integer, :cast => :to_i
         route_param :awesome, "Hash of the thingy"
 
         api_method :post, '/thing/:id/:awesome' do |id|
@@ -386,6 +386,7 @@ describe "Apiculture" do
       parsed_body = JSON.load(last_response.body)
       expect(parsed_body['foo']).to eq('bar')
     end
+
     it 'adds support for json_response to set http status code', run: true do
       @app_class = Class.new(Sinatra::Base) do
         extend Apiculture
@@ -399,6 +400,7 @@ describe "Apiculture" do
       post '/some-json'
       expect(last_response.status).to eq(201)
     end
+
     it 'adds support for json_halt' do
       @app_class = Class.new(Sinatra::Base) do
         extend Apiculture
@@ -430,5 +432,44 @@ describe "Apiculture" do
       parsed_body = JSON.load(last_response.body)
       expect(parsed_body).to eq({"error"=>"Nein.", "teapot"=>true})
     end
+
+    # Mocks didn't play well with setting the status in a sinatra action
+    class NilTestAction < Apiculture::Action
+      def perform
+        status 204
+        nil
+      end
+    end
+    it 'allows returning an empty body when the status is 204' do
+      @app_class = Class.new(Sinatra::Base) do
+        extend Apiculture
+        settings.show_exceptions = false
+        settings.raise_errors = true
+        api_method :get, '/nil204' do
+          action_result NilTestAction
+        end
+      end
+
+      get '/nil204'
+      expect(last_response.status).to eq(204)
+      expect(last_response.body).to be_empty
+    end
+
+    it "does not allow returning an empty body when the status isn't 204" do
+      # Mock out the perform call so that status doesn't change from the default of 200
+      expect_any_instance_of(NilTestAction).to receive(:perform).with(any_args).and_return(nil)
+      @app_class = Class.new(Sinatra::Base) do
+        extend Apiculture
+        settings.show_exceptions = false
+        settings.raise_errors = true
+        api_method :get, '/nil200' do
+          action_result NilTestAction
+        end
+      end
+
+      expect{
+        get '/nil200'
+      }.to raise_error(RuntimeError)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apiculture
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
 platform: ruby
 authors:
 - Julik Tarkhanov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-25 00:00:00.000000000 Z
+date: 2017-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: github-markup
   requirement: !ruby/object:Gem::Requirement
@@ -85,36 +85,36 @@ dependencies:
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.2'
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.2'
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -130,33 +130,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.12'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '10'
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -179,6 +179,7 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
+- ".gitignore"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -203,7 +204,8 @@ files:
 homepage: https://github.com/WeTransfer/apiculture
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -220,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Sweet API sauce on top of Sintra