api-extensions 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    N2U3NWJjOWY4MWM1OGY2ZDZjMDgwNWJmY2ZkODY2NTU3ZTYzZjQyZg==
+    Zjc1Mzk1NDQ4OGIyMDU2OWMzZmIxZDJhMjgyYzdlYmRmYmRiMTM0NA==
   data.tar.gz: !binary |-
-    OTJiZmZmOTI2NmU1ZTgyNjg5ODk4OGIxMzc1YzVkZDM2ZWQyY2I4Yw==
+    NzJjM2I5YjU5YWJmMWEwZDMyNmFiZTkxZjc1MWIwNjYwZjY5ZmQ4NA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZDY3NGM1MmU0MDRkNjQyM2FkY2FjNTc2MmI1YTA0OGJkOTM0MWIzZTc0MThm
-    YmM1YTAxMWUxZTdlNjE1OWJjNDFkNmJjZjczOGQ5ZDQyOWZlYzkxMWZkM2Rj
-    ODU1ZWFlMTRmZjY0YzllYTIxYTFlYTFlMjAwMTUxYWIzMDc0MWQ=
+    YTU5NDIyOTcxZDZiZTQ3MjY4ODUzNmNkNGJmN2ZmMzYzYWE3NzIzZWUyZWNm
+    MGE0MmQ4YjMwNmFhZjljZTRlZTBkYTdlOTUxZTM3ZjhmZDJhNzg4OWI4ZDZj
+    MjQwYTdlYWQxYTg2NWRkZWNjNDNkYzExMmUzMTBiNmU1MWM0Y2E=
   data.tar.gz: !binary |-
-    YWY5MWI3MTAwZjNiYWU2NmM0ODRkZmRmZjMxMmQzYjExNmY0ZGUyNjY0MGI5
-    ZDdhYzUyYThmODA2ZmJjNThkOTI4MTRjYTVjNWQ2Yzk5ZmZlZWUyMjI3OTI1
-    NDhjOGRiNjJiYmQ2M2QwNTY1NTQ4NGY1MTk5NzcwYzY0NGI5M2Q=
+    NGUyNmYwMWRlNmJmNTYxYmRjZGE3MmUyOGRlZDJlNTFmMzk0ODhmYzljMjZh
+    ZjM5MTUxMTk0MGY2ZGJhZWIxYTE3NzM1NGE3ZmQ1YjZjZGQ4ZmI5NjE1MjY2
+    ZTkzMzhhMmQxYmM4MjI0YjdiMTAwM2QyYjk5ZTc0MmFhNzcyZWI=

data/README.md

@@ -6,6 +6,7 @@ at [the api-doc repo](https://github.com/ncuesta/api-doc).
 Included extensions:
 
 - `fields`
+- `expand`
 
 ## Installation
 
@@ -23,6 +24,22 @@ Or install it yourself as:
 
 ## Usage
 
+### Including all extensions
+
+As a more convenient way of including **all** the extensions, you may just include the module
+`Api::Extensions::All` in your class and you will automatically have included all of the extensions
+listed below.
+
+```ruby
+require 'api/extensions/expand'
+
+class MyApiHandler
+  include Api::Extensions::All
+
+  expand_with :my_resource_fetching_method
+end
+```
+
 ### `expand` extension
 
 The behavior of this extension is best described at
@@ -37,9 +54,12 @@ Please note that this extension **requires that the including class responds to
 require 'api/extensions/expand'
 
 class MyApiHandler
+  include Api::Extensions::Expand
+
+  expand_with :go_fetch
 
-  def initialize
-    include Api::Extensions::Expand
+  def go_fetch(url)
+    # Go fetch the resource at the given URL and return it
   end
 
   def handle(request)
@@ -85,3 +105,19 @@ $ rake features
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Changelog
+
+### v0.0.3
+
+* Switched `expand` to some metaprogramming: made the fetch method configurable (was hardcoded to `get`)
+* Added a *meta module* `All` for including all API extensions in a single sentence
+
+### v0.0.2
+
+* Added `expand` extension
+
+### v0.0.1
+
+* Initial version
+* Included `fields` extension

data/features/step_definitions/expand_steps.rb

@@ -3,10 +3,12 @@ require 'api/extensions/expand'
 Before do
   @expand_processor = Object.new
   class << @expand_processor
-    def get url
-    end
+    include Api::Extensions::Expand
+
+    expand_with :go_fetch
 
-    include(Api::Extensions::Expand)
+    def go_fetch url
+    end
   end
 end
 

data/lib/api/extensions.rb

@@ -4,5 +4,14 @@ require 'api/extensions/version'
 
 module Api
   module Extensions
+    module All
+      # Convenience module for including all extensions at once
+      def self.included(base)
+        base.class_eval %Q{
+          include Api::Extensions::Expand
+          include Api::Extensions::Fields
+        }
+      end
+    end
   end
-end
+end

data/lib/api/extensions/expand.rb

@@ -6,9 +6,11 @@
 module Api
   module Extensions
     module Expand
-      # Check requirements on inclusion
+      # Add expand_with class method on inclusion
       def self.included(base)
-        raise ::Exception.new('Base class must implement a :get method to include the ExpandProcessor module') unless base.method_defined?(:get)
+        @@fetch_method_for_expand = :get
+
+        base.class_eval 'def self.expand_with(symbol); @@fetch_method_for_expand = symbol; end'
       end
 
       # Process the expand functional extension
@@ -44,7 +46,7 @@ module Api
       def expand(resource, link)
         if resource['links'].include?(link)
           sub_resource_uri = resource['links'][link]['href']
-          sub_resource     = get sub_resource_uri
+          sub_resource     = send(fetch_method_for_expand, sub_resource_uri)
 
           # 'self' links replace the original resource
           if link == 'self'
@@ -56,6 +58,11 @@ module Api
 
         resource
       end
+
+      private
+        def fetch_method_for_expand
+          @@fetch_method_for_expand
+        end
     end
   end
 end

data/lib/api/extensions/version.rb

@@ -1,5 +1,5 @@
 module Api
   module Extensions
-    VERSION = '0.0.2'
+    VERSION = '0.0.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-extensions
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Nahuel Cuesta Luengo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-29 00:00:00.000000000 Z
+date: 2013-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler