api_recipes 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NzBiNzgwZTQyYjI2MmU3NDk2Mzg3ZTA2ZmYzMWViM2E1YmRlN2RlNw==
+    YjgxODFjMzU4NzQwMjdkMWEyYTBlMmY1NWFjZTFkNmUwMTZhZDY5MQ==
   data.tar.gz: !binary |-
-    N2Y1YTc4OTcxZGI3NWYxYWJmMDAxZWY4N2ViZTA3N2EyYzdhY2JmMA==
+    MzljOTgzNWUxNDYyOTZhYjljMGYzM2FkZWY5YzI0NjQwYTU2ZWI5OQ==
 SHA512:
   metadata.gz: !binary |-
-    M2VhNDJlZjYxMzQ3YjkxNDkyOGFlYTI0OGI5MTJjMjM1ZWJmMWU5MTg4M2Rl
-    NjRlOWViOWVjNTk0NmRiZWYyMTA2MjAzNGFkYWU0YTc0YTgzNmUyNDE1NjA5
-    N2ZkZTEzZTNjMDUxNTY1YTE3N2Y1YTUxYzdiNTc1NGRlMDU1ZWQ=
+    ZThhMzdmYTY0YWNmZDU3NDVmN2M4ZTQ1YzhkYTQ5MTA0MWU4OGY2ZGFlM2Nj
+    Y2JmN2Y3MmIwNDM2YjY3MTc0NWEyYzc1ODVlZWYzNDk4NDI5YmI5OGIxOTRm
+    ZmIzYmViNWI1YzU4MjA1YmZkMjE5NzFlYmJiMjQxY2EzMGM5MjU=
   data.tar.gz: !binary |-
-    NzQxMWY0NGI3NzQzMzBlZDFjNWM0MjE0M2ZkNzQ1NTdjMGU5YmI2NTAzYWZi
-    ZTUzNjk5NDBiYzQ4ZjQ4MGY0ZWEzYzAxZjFkZGVjMmM1ZTVlZWM1NjljNjJj
-    NTQ0Nzg3MWU0OWU5MDE4M2UyMzAxNzY5NDk0MjY4ZjY3MGFhZDc=
+    Mjc0Y2MyNzFkNTY4Y2FjZjJmNWIwOTNjYmI0MmNmMWNhN2E0NjY3ZDUwNzU1
+    YjRhZmZmNjExZTZkNzg0N2Y0NzdkZjVjMzhhMGJkNzUzNGY0OWFkNDlmMDlk
+    YTg4ZTNlMGM5Zjg3MmRhZmM1YTE4NTgwMTI5NDExOTc3NDM2MmM=

data/README.md

@@ -2,7 +2,13 @@
 
 # ApiRecipes
 
-Consume HTTP APIs with style
+<p align="center">  
+  <img width="300" height="160" src="api_recipes.png"/>
+</p>
+
+Create your HTTP APIs recipes and tastefully consume it!
+
+Api recipes lets you easily describe and consume an HTTP API.
    
 ## Installation
 
@@ -26,26 +32,18 @@ Ruby 1.9.3 or higher.
 
 ## Usage
 
-... in progress. 
+Help needed.
 
 In the meantime take a look at the ``` examples ``` folder. Thank you.
 
 ## TODO
 
-* Write specs
+* Write specs (I know... this code has been wrote down on a hurry so please do not beat me)
 * Write a good Usage
 * Add more examples
+* Add documentation
 * Delete this TODO section
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 
-You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update 
-the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for 
-the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/madAle/api_recipes. 

data/lib/api_recipes/resource.rb

@@ -62,6 +62,21 @@ module ApiRecipes
       end
     end
 
+    def encode_residual_params(route_attributes, residual_params)
+      # If :encode_params_as is specified and avalable use it
+      if Settings::AVAILABLE_PARAMS_ENCODINGS.include? route_attributes[:encode_params_as].to_s
+        { route_attributes[:encode_params_as].to_sym => residual_params }
+      else
+        # default to query string params (get) or json (other methods)
+        case route_attributes[:method].to_sym
+          when :get
+            { params: residual_params }
+          when :post, :put, :patch, :delete
+            { json: residual_params }
+        end
+      end
+    end
+
     def extract_headers
       settings[:default_headers] || {}
     end
@@ -70,6 +85,9 @@ module ApiRecipes
     # e.g. webapp.alarms.index
     def generate_routes
       @routes.each do |route, attrs|
+        if attrs.is_a? Hash
+          attrs.deep_symbolize_keys!
+        end
         if route.eql? @name
           raise RouteNameClashError.new(route, @name)
         end
@@ -90,11 +108,11 @@ module ApiRecipes
 
     def port
       settings[:port] || case settings[:protocol]
-                            when 'http'
-                              80
-                            when 'https'
-                              443
-                          end
+                           when 'http'
+                             80
+                           when 'https'
+                             443
+                         end
     end
 
     def request
@@ -128,16 +146,15 @@ module ApiRecipes
       unless route_attributes
         route_attributes = {}
       end
-      unless method = route_attributes[:method]
-        method = Settings::DEFAULT_HTTP_VERB
-      end
+      # Merge route attributes with defaults
+      route_attributes = Settings::DEFAULT_ROUTE_ATTRIBUTES.merge route_attributes
 
       params = pars.extract_options!
       path, residual_params = build_path(route, route_attributes, params)
       residual_params = nil unless residual_params.any?
       uri = build_uri_from path
 
-      response = build_request.send(method.downcase, uri, json: residual_params)
+      response = build_request.send(route_attributes[:method], uri, encode_residual_params(route_attributes, residual_params))
       check_response_code route, route_attributes, response
 
       if block_given?

data/lib/api_recipes/settings.rb

@@ -14,6 +14,10 @@ module ApiRecipes
         routes: {}
     }
 
-    DEFAULT_HTTP_VERB = :get
+    DEFAULT_ROUTE_ATTRIBUTES = {
+      method: :get
+    }
+
+    AVAILABLE_PARAMS_ENCODINGS = %w(form params json body)
   end
 end

data/lib/api_recipes/version.rb

@@ -1,3 +1,3 @@
 module ApiRecipes
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_recipes
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Alessandro Verlato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-18 00:00:00.000000000 Z
+date: 2015-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -83,6 +83,7 @@ files:
 - README.md
 - Rakefile
 - api_recipes.gemspec
+- api_recipes.png
 - bin/console
 - bin/setup
 - examples/authorization.rb