flexirest 1.3.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc944642eeec80748c437111eb7e7b5b5ee98d40
-  data.tar.gz: f931c97b2a77159732a14e78e69f125ef006cd69
+  metadata.gz: 6710bc9498f0361be184d117313246aba2f8bba6
+  data.tar.gz: fee1ab9d2d860e40b71c0f612fc590d2e381704b
 SHA512:
-  metadata.gz: 72e1f0677d501933a37699452787dc2f7a43ee7919c94e362b6daf6f7eb1b5fd0fe65c5c7cd8254d90a1c9c2027ddbd4fa26151205f2976de7074421e7b9d1b4
-  data.tar.gz: 86f2aa14d43f8d16a3bdc69824e443eedb30ee6e645c402898d0dab9e0d41514f0ac26ae30acabecc90d599507fb9f19f85db0b2681d9be90b4fee3f5c300964
+  metadata.gz: d885fb9c26907c53037ac373922233ab1bba00dcf3c3f36e227aaae412fdbf47e201bbc07f11715bf794a603618600c98ee48bc3074a9ca040d3b5e5bca773c5
+  data.tar.gz: 0d8936b2fd3ffc16d0eaff6ff32ad7ba360fa5a933be80a5a70a06382d9927d5aca471075061111de67554b22f181f802d649085c485acb836c9033847b3dc23

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
+  - 2.3.0
   - 2.2.0
   - 2.1.0
   - 2.0.0

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 1.3.3
+
+Features:
+
+- New Ruby on Rails integration guide (thanks to Matthias Neumayr)
+- New `ignore_root` method to ignore JSON or XML root nodes, deprecated `ignore_xml_root` (thanks to dsarhadian for the request)
+
 ## 1.3.2
 
 Features:
@@ -10,7 +17,7 @@ Features:
 
 Features:
 
-- You can now use has_many/has_one on the class live, more like ActiveRecord
+- You can now use `has_many`/`has_one` on the class live, more like ActiveRecord
 
 ## 1.3.0
 
@@ -28,7 +35,7 @@ Features:
 
 Features:
 
-- Allow nil option in validators (thanks to Jurgen Jocubeit)
+- Allow `nil` option in validators (thanks to Jurgen Jocubeit)
 - Added array feature for returning simple scalar values (thanks to Jurgen Jocubeit)
 
 ## 1.2.17
@@ -41,7 +48,7 @@ Bugfixes:
 
 Feature:
 
-- Replaces URL :keyed parameters for direct requests.
+- Replaces URL `:keyed` parameters for direct requests.
 
 ## 1.2.15
 
@@ -55,8 +62,6 @@ Bugfixes:
 
 - Patch was partially implemented in 2014, but never completed. It should be working now (thanks to Joel Low)
 
-# Changelog
-
 ## 1.2.13
 
 Bugfixes:

data/README.md

@@ -31,7 +31,7 @@ First you need to create your new model class:
 
 ```ruby
 # config/environments/production.rb
-MyApp::Application.configure do
+Rails.application.configure do
   # ...
   config.api_server_url = "https://www.example.com/api/v1"
 end
@@ -123,6 +123,10 @@ If you want to debug the response, using inspect on the response object may well
 puts @person.to_json
 ```
 
+### Ruby on Rails Integration
+
+A detailed guide, how to integrate Flexirest with a RESTful resources can be found in the [Ruby-on-Rails-Integration.md](https://github.com/andyjeffries/flexirest/blob/master/Ruby-on-Rails-Integration.md).
+
 ## Advanced Features
 
 ### Faraday Configuration
@@ -786,6 +790,16 @@ class Person < Flexirest::Base
 end
 ```
 
+### Root element removal
+
+If your JSON or XML object comes back with a root node and you'd like to ignore it, you can define the mapping as:
+
+```ruby
+class Feed < Flexirest::Base
+  get :list, "/feed", ignore_root: "feed"
+end
+```
+
 ### Required Parameters
 
 If you want to specify that certain parameters are required for a specific call, you can specify them like:
@@ -917,9 +931,7 @@ class Article < Flexirest::Base
 end
 ```
 
-## Beta Features
-
-### XML Responses
+## XML Responses
 
 Flexirest uses Crack to allow parsing of XML responses.  For example, given an XML response of (with a content type of `application/xml` or `text/xml`):
 
@@ -971,14 +983,6 @@ puts @atom.feed.link.href
 end
 ```
 
-If your XML object comes back with a root node and you'd like to ignore it, you can define the mapping as:
-
-```ruby
-class Feed < Flexirest::Base
-  get :atom, "/atom", ignore_xml_root: "feed"
-end
-```
-
 For testing purposes, if you are using a `fake` content response when defining your endpoint, you should also provide `fake_content_type: "application/xml"` so that the parser knows to use XML parsing.
 
 ## Contributing

data/Ruby-on-Rails-Integration.md

@@ -0,0 +1,142 @@
+# Ruby on Rails Integration
+
+Flexirest works fine with Ruby on Rails Framework. This guide was tested with a Rails 4.2.x Application.
+
+
+## Integration
+
+Start referencing `flexirest` in your `Gemfile`
+
+```ruby
+# Gemfile
+gem 'flexirest'
+```
+
+
+## Configuration
+
+It's possible to explicit specify the `base_url` in the Model Class. If you have an common API Endpoint it makes sense to setup an initializer in `config/initializer` or use the `Rails.application.configure` namespace.
+
+This example use a custom file in `config/initializer` to setup the API endpoint. Either set a fixed URL or use environment variables if you would like to follow the [12factor](http://12factor.net/config) rules for preparing your application running on cloud infrastructure like heroku.
+
+```ruby
+# config/initializer/flexirest.rb
+Flexirest::Base.base_url = ENV.fetch("API_ENDPOINT_URL")
+```
+
+
+## Routes
+
+Like every other RESTful resource, just add the controller as a reference into your routes.
+
+```ruby
+# config/routes.rb
+
+Rails.application.routes.draw do
+  # ...
+  resources :people
+end
+```
+
+
+## Model
+
+The `ActiveModel` shortcuts will add support for `form_for` helper and `@person.errors` functionally in your views.
+For example, if you have a scaffolded view structure this will just work out of the box. Read more about `ActiveModel` here:
+
+ * [ActiveModel::Naming](http://api.rubyonrails.org/classes/ActiveModel/Naming.html)
+ * [ActiveModel::Conversion](http://api.rubyonrails.org/classes/ActiveModel/Conversion.html)
+ * [ActiveModel::Validations](http://api.rubyonrails.org/classes/ActiveModel/Validations.html)
+
+In Rails, a resourceful route provides a mapping between HTTP verbs and URLs to controller actions.
+Add the GET, POST, PATCH and DELETE methods that reflect to your endpoint.
+
+Add the `persisted?` method to your Class to support Rails named_routes, so you could use `edit_person_path(person)` without explicit pass the `person.id`.
+
+
+```ruby
+# app/models/person.rb
+class Person < Flexirest::Base
+
+  extend ActiveModel::Naming
+  include ActiveModel::Conversion
+  include ActiveModel::Validations
+
+  get    :all,     "/people"
+  get    :find,    "/people/:id"
+  patch  :update,  "/people/:id"
+  post   :save,    "/people"
+  delete :destroy, "/people/:id"
+
+  def persisted?
+    id.present?
+  end
+
+end
+```
+
+
+## Controller
+
+The Controller is structured like an standard RESTful Rails Controller. Only the `update` method has
+a small change about how params getting processed.
+
+Flexirest requires the `id` inside the params hash, this is not included by default.
+Easily merge the current id into the params with `person_params.merge(id: @person.id)`
+
+No other changes had to be made for the controller.
+
+```ruby
+# app/controller/people_controller.rb
+class PeopleController < ApplicationController
+  before_action :set_person, only: [:show, :edit, :update, :destroy]
+
+  def index
+    @people = Person.all
+  end
+
+  def show
+  end
+
+  def new
+    @person = Person.new
+  end
+
+  def edit
+  end
+
+  def create
+    @person = Person.new(person_params)
+
+    if @person.save
+      redirect_to @person, notice: 'Person was successfully created.'
+    else
+      render :new
+    end
+  end
+
+  def update
+    if @person.update(person_params.merge(id: @person.id))
+      redirect_to @person, notice: 'Person was successfully updated.'
+    else
+      render :edit
+    end
+  end
+
+  def destroy
+    @person.destroy
+    redirect_to people_url, notice: 'Person was successfully destroyed.'
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_person
+      @person = Person.find(params[:id])
+    end
+
+    # Never trust parameters from the scary internet, only allow the white list through.
+    def person_params
+      params.require(:person).permit(:title, :first_name, :last_name, :email)
+    end
+end
+```

data/lib/flexirest/request.rb

@@ -390,7 +390,8 @@ module Flexirest
           else
             Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Response received #{@response.body.size} bytes"
           end
-          result = generate_new_object(ignore_xml_root: @method[:options][:ignore_xml_root])
+          result = generate_new_object(ignore_root: @method[:options][:ignore_root], ignore_xml_root: @method[:options][:ignore_xml_root])
+          # TODO: Cleanup when ignore_xml_root is removed
         else
           raise ResponseParseException.new(status:status, body:@response.body)
         end
@@ -540,9 +541,15 @@ module Flexirest
         body = @response.body
       elsif is_json_response?
         body = @response.body.blank? ? {} : MultiJson.load(@response.body)
+        if options[:ignore_root]
+          body = body[options[:ignore_root].to_s]
+        end
       elsif is_xml_response?
         body = @response.body.blank? ? {} : Crack::XML.parse(@response.body)
-        if options[:ignore_xml_root]
+        if options[:ignore_root]
+          body = body[options[:ignore_root].to_s]
+        elsif options[:ignore_xml_root]
+          Flexirest::Logger.warn("Using `ignore_xml_root` is deprecated, please switch to `ignore_root`")
           body = body[options[:ignore_xml_root].to_s]
         end
       end

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.3.2"
+  VERSION = "1.3.3"
 end

data/spec/lib/request_spec.rb

@@ -81,6 +81,16 @@ describe Flexirest::Request do
       post :save, "/save"
     end
 
+    class IgnoredRootExampleClient < ExampleClient
+      get :root, "/root", ignore_root: "feed", fake: %Q{
+        {
+          "feed": {
+            "title": "Example Feed"
+          }
+        }
+      }
+    end
+
     allow_any_instance_of(Flexirest::Request).to receive(:read_cached_response)
   end
 
@@ -758,4 +768,8 @@ describe Flexirest::Request do
       expect(object._delegate?).to be_truthy
     end
   end
+
+  it "should ignore a specified root element" do
+    expect(IgnoredRootExampleClient.root.title).to eq("Example Feed")
+  end
 end

data/spec/lib/xml_spec.rb

@@ -2,7 +2,13 @@ require 'spec_helper'
 
 class XmlResponseExample < Flexirest::Base
   base_url "http://www.example.com/v1/"
-  get :root, "/root", ignore_xml_root: "feed", fake_content_type: "application/xml", fake: %Q{
+  get :root, "/root", ignore_root: "feed", fake_content_type: "application/xml", fake: %Q{
+    <?xml version="1.0" encoding="utf-8"?>
+    <feed xmlns="http://www.w3.org/2005/Atom">
+      <title>Example Feed</title>
+    </feed>
+  }
+  get :root_deprecated, "/root", ignore_xml_root: "feed", fake_content_type: "application/xml", fake: %Q{
     <?xml version="1.0" encoding="utf-8"?>
     <feed xmlns="http://www.w3.org/2005/Atom">
       <title>Example Feed</title>
@@ -71,4 +77,10 @@ describe XmlResponseExample do
     @feed = XmlResponseExample.root
     expect(@feed.title).to eq("Example Feed")
   end
+
+  it "allows ignoring of the XML root node using the deprecated call" do
+    expect(Flexirest::Logger).to receive(:warn).with("Using `ignore_xml_root` is deprecated, please switch to `ignore_root`")
+    @feed = XmlResponseExample.root_deprecated
+    expect(@feed.title).to eq("Example Feed")
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.3
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-26 00:00:00.000000000 Z
+date: 2016-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -253,6 +253,7 @@ files:
 - Migrating-from-ActiveRestClient.md
 - README.md
 - Rakefile
+- Ruby-on-Rails-Integration.md
 - doc/Flexirest Internals.graffle
 - doc/Flexirest Internals.png
 - flexirest.gemspec