api_hammer 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d45ffaa15ffd8ab1a5de56bfb6dbae6db3e91889
-  data.tar.gz: 1e8305cd7ce714d558c7968680c25ab0bde0e450
+  metadata.gz: b422b307a5753a8315b2bce549a2a18966c78ede
+  data.tar.gz: 9f23c48f532e57c59105da808f373879037640ff
 SHA512:
-  metadata.gz: fc16d15d0b8ca08659f067752fca417d1acaf6495ab4801b689b869661e37620f5d4a65ae4b60760af02fddcae171d5a7ad1a34342ecad7cc4c51ed0b4bb6e3a
-  data.tar.gz: f39a2705188c3ad4cd8ae5a77339e248e207b42470f19266c290eed55fbf7f326e5a72657dbe91d179fdfb3845a5bbd90acb384d1ec799207ae68c8d9c48399d
+  metadata.gz: 6edf87fe1bcac33ef5d2e74af2e93e366804d964a4f3ca0c6e581ab2e576b4698940eef276366e1aa728262fcdc7bd4ce00c406343f5d77597f7ebcd5957132d
+  data.tar.gz: 4bfd01db70492fc17227e38bfac2f5dc622e6b4ebec1e228573a8ca23fd354e0f2f1fa7b95a52c764f46174d208ced4fb4ad99c963e11639553991580ac4741b

data/.yardopts

@@ -0,0 +1 @@
+--main README.md --markup=markdown {lib}/**/*.rb

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.0.3
+- rake cucumber:pretty_json
+- Rails#find_or_halt
+
 # 0.0.2
 
 - Weblink#to_s

data/lib/api_hammer/halt.rb

@@ -48,51 +48,27 @@ module ApiHammer::Rails
     halt(status, {'errors' => errors}, render_options)
   end
 
-  module HaltMethods
-=begin
-# these methods are generated with the following script
-
-require 'nokogiri'
-require 'faraday'
-wpcodes = Nokogiri::HTML(Faraday.get('https://en.wikipedia.org/wiki/List_of_HTTP_status_codes').body)
-dts = wpcodes.css('dt')
-puts(dts.map do |dt|
-  if dt.text =~ /\A\s*(\d+)\s+([a-z0-9 \-']+)/i
-    status = $1.to_i
-    name = $2.strip
-    underscore = name.split(/[\s-]/).map{|word| word.downcase.gsub(/\W/, '') }.join('_')
-    if ([100..199, 490..499, 520..599].map(&:to_a).inject([], &:+) + [306, 420, 440, 449, 450]).include?(status)
-      # exclude these. 1xx isn't really a thing that makes sense at this level and the others are 
-      # nonstandard or particular particular web servers or such 
-      nil
-    elsif [204, 205, 304].include?(status)
-      # ones with no body
-%Q(
-  # halt with status #{status} #{name}
-  def halt_#{underscore}(render_options = {})
-    halt(#{status}, '', render_options)
+  # attempts to find and return the given model (an ActiveRecord::Base subclass) with the given attributes. 
+  # halts with 404 (does not return) if that fails. options[:status] may specify a different status if that 
+  # is required.
+  #
+  # e.g.:
+  #
+  #     find_or_halt(User, :email => 'user@example.com')
+  #
+  def find_or_halt(model, find_attrs, options={})
+    options = {:status => 404}.merge(options)
+    record = model.where(find_attrs).first
+    unless record
+      attributes = find_attrs.map{|attr, val| "#{attr}: #{val}" }.join(", ")
+      model_name = model.table_name
+      model_name = model_name.singularize if model_name.respond_to?(:singularize)
+      halt_error(options[:status], {model_name => ["Unknown #{model_name}! #{attributes}"]})
+    end
+    record
   end
-)
-    elsif (400..599).include?(status)
-      # body goes on an errors object
-%Q(
-  # halt with status #{status} #{name}, responding with the given errors object on the 'errors' key
-  def halt_#{underscore}(errors, render_options = {})
-    halt_error(#{status}, errors, render_options)
-  end
-)
-    else
-%Q(
-  # halt with status #{status} #{name}, responding with the given body object 
-  def halt_#{underscore}(body, render_options = {})
-    halt(#{status}, body, render_options)
-  end
-)
-    end
-  end
-end.compact.join)
 
-=end
+  module HaltMethods
     # halt with status 200 OK, responding with the given body object 
     def halt_ok(body, render_options = {})
       halt(200, body, render_options)
@@ -397,6 +373,50 @@ end.compact.join)
     def halt_network_authentication_required(errors, render_options = {})
       halt_error(511, errors, render_options)
     end
+=begin
+# the above methods are generated with the following script
+
+require 'nokogiri'
+require 'faraday'
+wpcodes = Nokogiri::HTML(Faraday.get('https://en.wikipedia.org/wiki/List_of_HTTP_status_codes').body)
+dts = wpcodes.css('dt')
+puts(dts.map do |dt|
+  if dt.text =~ /\A\s*(\d+)\s+([a-z0-9 \-']+)/i
+    status = $1.to_i
+    name = $2.strip
+    underscore = name.split(/[\s-]/).map{|word| word.downcase.gsub(/\W/, '') }.join('_')
+    if ([100..199, 490..499, 520..599].map(&:to_a).inject([], &:+) + [306, 420, 440, 449, 450]).include?(status)
+      # exclude these. 1xx isn't really a thing that makes sense at this level and the others are 
+      # nonstandard or particular particular web servers or such 
+      nil
+    elsif [204, 205, 304].include?(status)
+      # ones with no body
+%Q(
+  # halt with status #{status} #{name}
+  def halt_#{underscore}(render_options = {})
+    halt(#{status}, '', render_options)
+  end
+)
+    elsif (400..599).include?(status)
+      # body goes on an errors object
+%Q(
+  # halt with status #{status} #{name}, responding with the given errors object on the 'errors' key
+  def halt_#{underscore}(errors, render_options = {})
+    halt_error(#{status}, errors, render_options)
+  end
+)
+    else
+%Q(
+  # halt with status #{status} #{name}, responding with the given body object 
+  def halt_#{underscore}(body, render_options = {})
+    halt(#{status}, body, render_options)
+  end
+)
+    end
+  end
+end.compact.join)
+
+=end
   end
 
   include HaltMethods

data/lib/api_hammer/tasks/cucumber_pretty.rb

@@ -0,0 +1,54 @@
+namespace :cucumber do
+  desc "replaces json in pystrings in feature files with pretty-printed json"
+  task :pretty_json do
+    require 'json'
+
+    features = Dir['features/**/*.feature']
+
+    features.each do |feature_file|
+      any_changes = false
+      feature = File.read(feature_file)
+      line_blocks = [[]]
+      feature.split("\n", -1).each do |line|
+        triq = line =~ /\A\s*"""\s*\z/
+        line_blocks << [] if triq
+        line_blocks.last << line
+        line_blocks << [] if triq
+      end
+
+      line_blocks.each_slice(4) do |steps, triq1, quoted_string_parts, triq2|
+        next unless triq1 # last one
+        quoted_string = quoted_string_parts.join("\n")
+        ws = triq1.first[/\A\s*/]
+        ws += '  '
+
+        begin
+          object = JSON.parse(quoted_string)
+          # I don't like how JSON prettifies empty arrays and objects - special case these 
+          if object == []
+            pretty_json = '[]'
+          elsif object == {}
+            pretty_json = '{}'
+          else
+            pretty_json = JSON.pretty_generate(object)
+          end
+          pretty_quoted_string_parts = pretty_json.split("\n", -1).grep(/\S/).map{|jline| "#{ws}#{jline}" }
+          unless pretty_quoted_string_parts == quoted_string_parts
+            quoted_string_parts.replace(pretty_quoted_string_parts)
+            any_changes = true
+          end
+        rescue JSON::ParserError
+          # that wasn't json. leave it alone. 
+        end
+
+      end
+
+      if any_changes
+        STDERR.puts "prettifying json: #{feature_file}"
+        File.open(feature_file, 'w') do |f|
+          f.write(line_blocks.inject([], &:+).join("\n"))
+        end
+      end
+    end
+  end
+end

data/lib/api_hammer/tasks.rb

@@ -0,0 +1,4 @@
+require 'pathname'
+Pathname.new(__FILE__).dirname.join('tasks').children.select { |c| c.to_s =~ /\.rb\z/ }.each do |taskfile|
+  require taskfile
+end

data/lib/api_hammer/version.rb

@@ -1,3 +1,3 @@
 module ApiHammer
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/halt_test.rb

@@ -31,6 +31,31 @@ describe 'ApiHammer::Rails#halt' do
       assert_equal(422, haltex.render_options[:status])
     end
   end
+
+  describe 'find_or_halt' do
+    it 'returns a record if it exists' do
+      record = Object.new
+      model = Class.new do
+        (class << self; self; end).class_eval do
+          define_method(:where) { |attrs| [record] }
+          define_method(:table_name) { 'records' }
+        end
+      end
+      assert_equal record, FakeController.new.find_or_halt(model, {:id => 'anid'})
+    end
+    it 'it halts with 404 if not' do
+      record = Object.new
+      model = Class.new do
+        (class << self; self; end).class_eval do
+          define_method(:where) { |attrs| [] }
+          define_method(:table_name) { 'record' }
+        end
+      end
+      haltex = assert_raises(ApiHammer::Halt) { FakeController.new.find_or_halt(model, {:id => 'anid'}) }
+      assert_equal({'errors' => {'record' => ['Unknown record! id: anid']}}, haltex.body)
+      assert_equal(404, haltex.render_options[:status])
+    end
+  end
 end
 
 describe 'ApiHammer::Rails#handle_halt' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_hammer
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ethan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-01 00:00:00.000000000 Z
+date: 2014-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -145,6 +145,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".simplecov"
+- ".yardopts"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
@@ -155,6 +156,8 @@ files:
 - lib/api_hammer/rails.rb
 - lib/api_hammer/request_logger.rb
 - lib/api_hammer/show_text_exceptions.rb
+- lib/api_hammer/tasks.rb
+- lib/api_hammer/tasks/cucumber_pretty.rb
 - lib/api_hammer/tasks/gem_available_updates.rb
 - lib/api_hammer/trailing_newline.rb
 - lib/api_hammer/version.rb