acts_as_api 0.4.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f83008775d02827f67246d2c3d6de3611318a279
-  data.tar.gz: 8827a13005d4caaa92561987fa503feea450be86
+  metadata.gz: e16fbb94ed887cceb26f045b1249335016a07682
+  data.tar.gz: 40ad8d4be72657344be7ad856eb7c83b66dcf389
 SHA512:
-  metadata.gz: 8710cf02573c85ca1a902b2d48d42955c251058ac4f01eeb95a26bae402a9158fe8032ed52c82990ffd8cb9d0ec4bbb45a027fd5d2285fd99157585ff8626e29
-  data.tar.gz: 875d70c8a6ccb93fe4ed2eda2a6a565ae87fca28c37fd8e87e82c360c66ee1a74c113c0bdac5d65b6b917326e31e58e78866d481f0b8462812f3ba3eb4282a43
+  metadata.gz: d08be30be0f420cd61e61bb3da1e98b798d420e8c6a8be3afadafa1e897c0c3180f734a2c374baa711afbd07b56b09503fa3dd25eaf041622aa5b119cfbf8917
+  data.tar.gz: 68debff236e8e0e78203841aa33c253949b36dfb518c3d5f75f9ad5bc7002ec01090c80dc0b441e57d363b6c141b36d1d2b1adaa60cb226c7900f3683c5383ed

data/Gemfile

@@ -1,19 +1,16 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
 # Specify your gem's dependencies in acts_as_api.gemspec
 gemspec
 
 group :test do
   gem 'pry'
-  gem 'test-unit', '~> 3.0'
   gem 'sqlite3'
   gem 'mongoid', '>= 6.0.2'
-  gem 'rspec', '>= 2.9.0'
-  gem 'rspec-its'
+  gem 'rspec', '>= 3.5.0'
   gem 'rspec-collection_matchers'
   gem 'capybara'
-  gem 'rspec-rails', '>= 2.5.0'
-  gem 'webrat'
+  gem 'rspec-rails', '>= 3.5.0'
   gem 'responders'
-  gem 'shared_engine', :path => './spec/shared_engine'
+  gem 'shared_engine', path: './spec/shared_engine'
 end

data/History.txt

@@ -1,3 +1,8 @@
+=== 1.0.0 2016-11-24
+
+* Ditch Ruby 1.8 syntax, overall modernization
+* Finally, 1.0!
+
 === 0.4.4 2016-11-09
 
 * Updates spec suite to Rails 5

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Christian Bäuerlein
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -84,28 +84,3 @@ There are a lot of how-tos like:
 
 Note that upgrading to 0.3.0 will break code that worked with previous versions due to a complete overhaul of the lib.
 For a legacy version of this readme file look here: https://github.com/fabrik42/acts_as_api/wiki/legacy-acts_as_api-0.2-readme
-
-### LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2010 Christian Bäuerlein
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -7,13 +7,12 @@ Bundler::GemHelper.install_tasks
 RSpec::Core::RakeTask.new
 
 namespace :spec do
-
   supported_orms = %w(mongoid active_record)
 
   supported_orms.each do |orm|
     desc "Run #{orm} specs only"
     RSpec::Core::RakeTask.new(orm) do |t|
-      t.rspec_opts = ["--color"]
+      t.rspec_opts = ['--color']
     end
 
     task "prepare_#{orm}" do
@@ -23,26 +22,20 @@ namespace :spec do
     Rake::Task["spec:#{orm}"].prerequisites << "spec:prepare_#{orm}"
   end
 
-
-#  task :all => supported_orms.map{|orm| "spec:#{orm}"}
-
   desc "Runs specs for all ORMs (#{supported_orms.join(', ')})"
   task :all do
     supported_orms.each do |orm|
       puts "Starting to run specs for #{orm}..."
       system("bundle exec rake spec:#{orm}")
-      raise "#{orm} failed!" unless $?.exitstatus == 0
+      raise "#{orm} failed!" unless $?.exitstatus.zero?
     end
   end
 
 end
 
+task default: 'spec:all'
 
-gemspec = Gem::Specification.load("acts_as_api.gemspec")
-
-task :default => "spec:all"
-
-desc "Generate the gh_pages site"
+desc 'Generate the gh_pages site'
 task :rocco do
-  system "bundle exec rocco examples/introduction/index.rb -t examples/introduction/layout.mustache"
+  system 'bundle exec rocco docs/index.rb -t docs/layout.mustache'
 end

data/acts_as_api.gemspec

@@ -1,28 +1,29 @@
 # encoding: utf-8
-$:.push File.expand_path("../lib", __FILE__)
-require "acts_as_api/version"
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'acts_as_api/version'
 
 Gem::Specification.new do |s|
-  s.name        = "acts_as_api"
+  s.name        = 'acts_as_api'
   s.version     = ActsAsApi::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Christian Bäuerlein"]
-  s.email       = ["christian@ffwdme.com"]
-  s.homepage    = "https://github.com/fabrik42/acts_as_api"
-  s.summary     = %q{Makes creating XML/JSON responses in Rails 3, 4 and 5 easy and fun.}
-  s.description = %q{acts_as_api enriches the models and controllers of your app in a rails-like way so you can easily determine how your XML/JSON API responses should look like.}
+  s.authors     = ['Christian Bäuerlein']
+  s.email       = ['christian@ffwdme.com']
+  s.homepage    = 'https://github.com/fabrik42/acts_as_api'
+  s.summary     = 'Makes creating XML/JSON responses in Rails 3, 4 and 5 easy and fun.'
+  s.description = 'acts_as_api enriches the models and controllers of your app in a rails-like way so you can easily determine how your XML/JSON API responses should look like.'
 
-  s.add_dependency('activemodel','>= 3.0.0')
-  s.add_dependency('activesupport','>= 3.0.0')
-  s.add_dependency('rack','>= 1.1.0')
+  s.add_dependency('activemodel', '>= 3.0.0')
+  s.add_dependency('activesupport', '>= 3.0.0')
+  s.add_dependency('rack', '>= 1.1.0')
 
   s.add_development_dependency('rails', ['>= 3.2.22.2'])
   s.add_development_dependency('mongoid', ['>= 3.0.1'])
+  s.add_development_dependency('rocco', ['>= 0.8.0'])
 
   s.rdoc_options  = ['--charset=UTF-8']
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
 end

data/{examples/introduction → docs}/index.html

@@ -44,10 +44,10 @@
         <p>The built-in XML/JSON support of Rails is great but:
 You surely don’t want to expose your models always with all attributes.</p>
 
-<p>acts_as_api enriches the models and controllers of your app in a rails-like way so you can easily determine how your API responses should look like.</p>
+<p>acts<em>as</em>api enriches the models and controllers of your app in a rails-like way so you can easily determine how your API responses should look like.</p>
       </td>
       <td class=code>
-        <div class='highlight'><pre></pre></div>
+        <div class='highlight'><pre><span></span></pre></div>
       </td>
     </tr>
     <tr id='section-Features'>
@@ -60,17 +60,16 @@ You surely don’t want to expose your models always with all attributes.</p>
 <ul>
 <li>DRY templates for your api responses</li>
 <li>Ships with support for <strong>ActiveRecord</strong> and <strong>Mongoid</strong></li>
-<li>Support for Rails 3/4 Responders (extracted to responders gem since Rails 5)</li>
+<li>Support for Rails 3, 4 and 5 Responders</li>
 <li>Plays very well together with client libs like <a href="http://documentcloud.github.com/backbone">Backbone.js</a> or <a href="http://restkit.org">RestKit</a> (iOS).</li>
 <li>Easy but very flexible syntax for defining the templates</li>
 <li>XML, JSON and JSON-P support out of the  box, easy to extend</li>
-<li>Support for meta data like pagination info, etc&hellip;</li>
+<li>Support for meta data like pagination info, etc...</li>
 <li>Minimal dependecies (you can also use it without Rails)</li>
 <li>Supports multiple api rendering templates for a models. This is especially useful for API versioning or for example for private vs. public access points to a user’s profile.</li>
 </ul>
 
-
-<hr />
+<hr>
       </td>
       <td class=code>
         <div class='highlight'><pre></pre></div>
@@ -81,7 +80,7 @@ You surely don’t want to expose your models always with all attributes.</p>
         <div class="pilwrap">
           <a class="pilcrow" href="#section-Rails_3.x_Quickstart">&#182;</a>
         </div>
-        <h2>Rails Quickstart</h2>
+        <h2>Rails 3.x Quickstart</h2>
       </td>
       <td class=code>
         <div class='highlight'><pre></pre></div>
@@ -139,7 +138,7 @@ If you only want to expose the <code>first_name</code> and <code>last_name</code
         </div>
         <p>Within your model:</p>
 
-<p>First you activate acts_as_api for your model by calling <code>acts_as_api</code>.</p>
+<p>First you activate acts<em>as</em>api for your model by calling <code>acts_as_api</code>.</p>
 
 <p>Then you define an api template to render the model with <code>api_accessible</code>.</p>
       </td>
@@ -199,7 +198,7 @@ If you only want to expose the <code>first_name</code> and <code>last_name</code
         <div class="pilwrap">
           <a class="pilcrow" href="#section-12">&#182;</a>
         </div>
-        <p>Note that it&rsquo;s wise to add a <code>root</code> param when rendering lists.</p>
+        <p>Note that it&#39;s wise to add a <code>root</code> param when rendering lists.</p>
       </td>
       <td class=code>
         <div class='highlight'><pre>    <span class="n">respond_to</span> <span class="k">do</span> <span class="o">|</span><span class="nb">format</span><span class="o">|</span>
@@ -220,12 +219,12 @@ If you only want to expose the <code>first_name</code> and <code>last_name</code
 <span class="k">end</span></pre></div>
       </td>
     </tr>
-    <tr id='section-That&amp;rsquo;s_it!'>
+    <tr id='section-That&amp;#39;s_it!'>
       <td class=docs>
         <div class="pilwrap">
-          <a class="pilcrow" href="#section-That&amp;rsquo;s_it!">&#182;</a>
+          <a class="pilcrow" href="#section-That&amp;#39;s_it!">&#182;</a>
         </div>
-        <h3>That&rsquo;s it!</h3>
+        <h3>That&#39;s it!</h3>
       </td>
       <td class=code>
         <div class='highlight'><pre></pre></div>
@@ -255,20 +254,20 @@ because they were not listed by <code>api_accessible</code> in the model.</p>
         <div class="pilwrap">
           <a class="pilcrow" href="#section-15">&#182;</a>
         </div>
-        <hr />
+        <hr>
       </td>
       <td class=code>
         <div class='highlight'><pre></pre></div>
       </td>
     </tr>
-    <tr id='section-But_wait!_&amp;hellip;_there&amp;rsquo;s_more'>
+    <tr id='section-But_wait!_..._there&amp;#39;s_more'>
       <td class=docs>
         <div class="pilwrap">
-          <a class="pilcrow" href="#section-But_wait!_&amp;hellip;_there&amp;rsquo;s_more">&#182;</a>
+          <a class="pilcrow" href="#section-But_wait!_..._there&amp;#39;s_more">&#182;</a>
         </div>
-        <h2>But wait! &hellip; there&rsquo;s more</h2>
+        <h2>But wait! ... there&#39;s more</h2>
 
-<p>Often the pure rendering of database values is just not enough, so acts_as_api
+<p>Often the pure rendering of database values is just not enough, so acts<em>as</em>api
 provides you some tools to customize your API responses.</p>
       </td>
       <td class=code>
@@ -286,7 +285,7 @@ provides you some tools to customize your API responses.</p>
 
 <ul>
 <li><a href="https://github.com/fabrik42/acts_as_api/wiki/Calling-a-method-of-the-model">Include attributes and all other kinds of methods of your model</a></li>
-<li><a href="https://github.com/fabrik42/acts_as_api/wiki/Including-a-child-association">Include child associations (if they also act_as_api this will be considered)</a></li>
+<li><a href="https://github.com/fabrik42/acts_as_api/wiki/Including-a-child-association">Include child associations (if they also act<em>as</em>api this will be considered)</a></li>
 <li><a href="https://github.com/fabrik42/acts_as_api/wiki/Calling-a-lambda-in-the-api-template">Include lambdas and Procs</a></li>
 <li><a href="https://github.com/fabrik42/acts_as_api/wiki/Calling-a-method-of-the-model">Call methods of a parent association</a></li>
 <li><a href="https://github.com/fabrik42/acts_as_api/wiki/Calling-a-scope-of-a-sub-resource">Call scopes of your model or child associations</a></li>
@@ -294,7 +293,6 @@ provides you some tools to customize your API responses.</p>
 <li><a href="https://github.com/fabrik42/acts_as_api/wiki/Creating-a-completely-different-response-structure">Create your own hierarchies</a></li>
 </ul>
 
-
 <p>You can find more advanced examples in the <a href="https://github.com/fabrik42/acts_as_api/wiki/">Github Wiki</a></p>
       </td>
       <td class=code>
@@ -306,7 +304,7 @@ provides you some tools to customize your API responses.</p>
         <div class="pilwrap">
           <a class="pilcrow" href="#section-18">&#182;</a>
         </div>
-        <hr />
+        <hr>
       </td>
       <td class=code>
         <div class='highlight'><pre></pre></div>
@@ -326,7 +324,6 @@ provides you some tools to customize your API responses.</p>
 <li><a href="http://rdoc.info/github/fabrik42/acts_as_api">Docs</a></li>
 </ul>
 
-
       </td>
       <td class=code>
         <div class='highlight'><pre></pre></div>

data/lib/acts_as_api.rb

@@ -1,12 +1,9 @@
 require 'active_model'
 require 'active_support/core_ext/class'
 
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-
-require "acts_as_api/collection"
-require "acts_as_api/rails_renderer"
-require "acts_as_api/exceptions"
+require 'acts_as_api/collection'
+require 'acts_as_api/rails_renderer'
+require 'acts_as_api/exceptions'
 
 # acts_as_api is a gem that aims to make the construction of JSON and XML
 # responses in Rails 3, 4 and 5 easy and fun.
@@ -17,12 +14,12 @@ require "acts_as_api/exceptions"
 # acts_as_api uses the default serializers of your rails app and doesn't
 # force you into more dependencies.
 module ActsAsApi
-  autoload :Config,       "acts_as_api/config"
-  autoload :ApiTemplate,  "acts_as_api/api_template"
-  autoload :Base,         "acts_as_api/base"
-  autoload :Rendering,    "acts_as_api/rendering"
-  autoload :Responder,    "acts_as_api/responder"
-  autoload :Adapters,     "acts_as_api/adapters"
+  autoload :Config,      'acts_as_api/config'
+  autoload :ApiTemplate, 'acts_as_api/api_template'
+  autoload :Base,        'acts_as_api/base'
+  autoload :Rendering,   'acts_as_api/rendering'
+  autoload :Responder,   'acts_as_api/responder'
+  autoload :Adapters,    'acts_as_api/adapters'
 end
 
 # Neccessary to render an Array of models, e.g. the result of a search.

data/lib/acts_as_api/adapters.rb

@@ -1,5 +1,5 @@
 module ActsAsApi
   module Adapters
-    autoload :Mongoid, "acts_as_api/adapters/mongoid"
+    autoload :Mongoid, 'acts_as_api/adapters/mongoid'
   end
 end

data/lib/acts_as_api/api_template.rb

@@ -8,7 +8,6 @@ module ActsAsApi
   # Please note that +ApiTemplate+ inherits from +Hash+ so you can use all
   # kind of +Hash+ and +Enumerable+ methods to manipulate the template.
   class ApiTemplate < Hash
-
     # The name of the api template as a Symbol.
     attr_accessor :api_template
 
@@ -21,7 +20,7 @@ module ActsAsApi
 
     def merge!(other_hash, &block)
       super
-      self.options.merge!(other_hash.options) if other_hash.respond_to?(:options)
+      options.merge!(other_hash.options) if other_hash.respond_to?(:options)
     end
 
     # Adds a field to the api template
@@ -44,7 +43,7 @@ module ActsAsApi
 
     # Removes a field from the template
     def remove(field)
-      self.delete(field)
+      delete(field)
     end
 
     # Returns the options of a field in the api template
@@ -67,9 +66,9 @@ module ActsAsApi
     # the response based on the conditional options passed.
     def allowed_to_render?(fieldset, field, model, options)
       return true unless fieldset.is_a? ActsAsApi::ApiTemplate
-      
+
       fieldset_options = fieldset.options_for(field)
-      
+
       if fieldset_options[:unless]
         !(condition_fulfilled?(model, fieldset_options[:unless], options))
       elsif fieldset_options[:if]
@@ -112,28 +111,27 @@ module ActsAsApi
       api_output
     end
 
-  private
-
-    def process_value(model, value, options)
-      case value
-      when Symbol
-        model.send(value)
-      when Proc
-        call_proc(value,model,options)
-      when String
-        value.split('.').inject(model) { |result, method| result.send(method) }
-      when Hash
-        to_response_hash(model, value)
+    private
+
+      def process_value(model, value, options)
+        case value
+        when Symbol
+          model.send(value)
+        when Proc
+          call_proc(value, model, options)
+        when String
+          value.split('.').inject(model) { |result, method| result.send(method) }
+        when Hash
+          to_response_hash(model, value)
+        end
       end
-    end
 
-    def call_proc(the_proc,model,options)
-      if the_proc.arity == 2
-        the_proc.call(model, options)
-      else
-        the_proc.call(model)
+      def call_proc(the_proc, model, options)
+        if the_proc.arity == 2
+          the_proc.call(model, options)
+        else
+          the_proc.call(model)
+        end
       end
-    end
-
   end
 end