served 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18d0b5a5d6bc54eed0cc6d6ff0485342c9487863
-  data.tar.gz: e4cd8e832643622713b0aa8d5343ebd451609b40
+  metadata.gz: 9fc33f665810efb0338be77783f46f28a79604a3
+  data.tar.gz: 9141fc737d07f6d9d8fdf235cbb3ac6dfd335a89
 SHA512:
-  metadata.gz: 42193c7f1e6d2356244fd48894a9a254680cbeb3ffdd0a587346a223d013619dd85a9a40dcde6bac091e881fd004ea7ad74d5d33a44d0a6dcb7a4c96ac1d750b
-  data.tar.gz: 338753924c4f965a38d45db21b225439d70dac94092442e36ed66b05514a3518fe087c3fa95919b911c2847deb0a637c555cb1f16d134a8038d848bcf4b0ad52
+  metadata.gz: f38dae786e45652389e082659118258eb77d6bbccf34fe9f358321bfca0b2e416a7f7080c4523a6ccfa927fed2503e9aceb0d80b61755475c015eb71ed215658
+  data.tar.gz: 15ac1e21e7e1557b53de03862cb3a622e3b0fa33618c010d64c0fa3545e3e9b3a7fdf809db0369bca22a1302c8755352691ff375145c16dd5e8296c0aafde22e

data/README.md

@@ -1,8 +1,9 @@
 # Served
 [![Build Status](https://travis-ci.org/optoro/served.svg)](https://travis-ci.org/optoro/served)
+[![Gem Version](https://badge.fury.io/rb/served.svg)](https://badge.fury.io/rb/served)
 
 Served is a gem in the vein of [ActiveResource](https://github.com/rails/activeresource) designed to facilitate
-communication between distributed Rails services.
+communication between distributed services and APIs.
 
 # Installation
 
@@ -10,58 +11,55 @@ Add the following to your Gemfile:
 
 ```gem 'served'```
 
-
-# Usage
-A service model can be created by declaring a class inheriting from ```Service::Resource::Base```.
+# Configuration
+Served is configured by passing a block to ```Served::configure```.
 
 ```ruby
-class SomeService::SomeResource < Served::Resource::Base
-
-   attribute :name
-   attribute :date
-   attribute :phone_number, default: '555-555-5555'
-
+Served.configure do |config|
+  config.hosts = {
+    'some_service' => 'http://localhost:3000'
+   }
+   
+   config.timeout = 100
 end
 ```
 
-## Saving a resource
-Served follows resourceful standards. When a resource is initially saved a **POST** request will be sent
-to the service. When the resource already exists, a **PUT** request will be sent. Served determines if
-a resource is new or not based on the presence of an id.
+## Hosts
+Served models derive their hostname by mapping their parent module to the ```Served::hosts``` configuration hash. For
+example, ```SomeService::SomeResource``` would look up its host configuration at 
+```Served.config.hosts['some_service']```.
 
-# Configuration
+The host configuration accepts an (Addressable)[https://github.com/sporkmonger/addressable] template mapping
+```resource``` as the resource name (derived from the model name) and ```query``` as the params. For example:
 
-Served is configured using ```Served.config```.
+```
+http://localhost:3000/{resource}{?query*}
+```
 
-## Configuration Options
+For more on building Addressable templates view the addressable documentation. If the host configuration is not an
+Addressable template, a default template will be applied (```{resource}.json{?query*}```). This is the current
+maintained for backwards compatibility, however the extension will likely be removed for the 0.2 release.
 
-### Hosts (required)
+## Timeout
+Sets the request timeout in milliseconds.
 
-Served uses the adjacent namespace of the resource to determine the the url for that service. For example given this
-configuration:
 
-```ruby
-Served.configure do |c|
-  c.hosts = {
-    some_service:       'http://localhost:3000',
-    some_other_service: 'http://localhost:3001'
-  }
-```
-
-and given this resource
+# Usage
+A service model can be created by declaring a class inheriting from ```Service::Resource::Base```.
 
 ```ruby
 class SomeService::SomeResource < Served::Resource::Base
 
    attribute :name
    attribute :date
-   attribute :phone_number
+   attribute :phone_number, default: '555-555-5555'
 
 end
 ```
 
-```SomeService::SomeResource``` would map back to http://localhost:3000/some_resources.
+## Saving a resource
+Served follows resourceful standards. When a resource is initially saved a **POST** request will be sent
+to the service. When the resource already exists, a **PUT** request will be sent. Served determines if
+a resource is new or not based on the presence of an id.
 
-### Timeout
 
-Sets the request time out.

data/lib/served/http_client.rb

@@ -1,35 +1,35 @@
+require 'addressable/template'
 module Served
   # Provides an interface between HTTParty and the models. Most of the crap in here is self explanatory
   class HTTPClient
     HEADERS = { 'Content-type' => 'application/json', 'Accept' => 'application/json' }
+    DEFAULT_TEMPLATE = '{resource}.json{?query*}'
 
     def initialize(host)
-      @host = host
+      unless host =~ /{.+}/
+        host = "#{host}/#{DEFAULT_TEMPLATE}"
+      end
+      @template = Addressable::Template.new(host)
     end
 
     def get(endpoint, params={})
-      HTTParty.get("#{@host}/#{endpoint}",
-                   query: params,
+      HTTParty.get(@template.expand(query: params, resource: endpoint).to_s,
                    headers: HEADERS,
                    timeout: Served.config.timeout
       )
     end
 
     def put(endpoint, body, params={})
-      HTTParty.put(
-        "#{@host}/#{endpoint}",
+      HTTParty.put(@template.expand(query: params, resource: endpoint).to_s,
         body:    body,
-        query:   params,
         headers: HEADERS,
         timeout: Served.config.timeout
       )
     end
 
     def post(endpoint, body, params={})
-      HTTParty.post(
-        "#{@host}/#{endpoint}",
+      HTTParty.post(@template.expand(query: params, resource: endpoint).to_s,
         body:    body,
-        query:   params,
         headers: HEADERS,
         timeout: Served.config.timeout
       )

data/lib/served/resource/base.rb

@@ -45,16 +45,16 @@ module Served
           name.split('::').last.tableize
         end
 
-        # @return [String] the configured host.
+        # @return [String] or [Hash] the configured host.
         # @see Services::Configuration
-        def host
+        def host_config
           Served.config[:hosts][parent.name.underscore.split('/')[-1]]
         end
 
         # @return [Served::HTTPClient] The connection instance to the service host. Note this is not an active
         # connection but a passive one.
         def client
-          @connection ||= Served::HTTPClient.new(host)
+          @connection ||= Served::HTTPClient.new(host_config)
         end
 
         private
@@ -121,17 +121,17 @@ module Served
       private
 
       def get(params={})
-        handle_response(client.get("/#{resource_name}/#{id}.json", params))
+        handle_response(client.get("#{resource_name}/#{id}", params))
       end
 
       def put(params={})
         body = to_json
-        handle_response(client.put("/#{resource_name}/#{id}.json", body, params))
+        handle_response(client.put("#{resource_name}/#{id}", body, params))
       end
 
       def post(params={})
         body = to_json
-        handle_response(client.post("/#{resource_name}.json", body, params))
+        handle_response(client.post("#{resource_name}", body, params))
       end
 
       def handle_response(response)

data/lib/served/version.rb

@@ -1,3 +1,3 @@
 module Served
-  VERSION = '0.1.6'
+  VERSION = '0.1.7'
 end

data/served.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'httparty'
   spec.add_dependency 'activesupport', '>= 3.2'
+  spec.add_dependency 'addressable',   '>= 2.4.0'
 
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: served
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Jarod Reid
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-10 00:00:00.000000000 Z
+date: 2015-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement