her 0.5.3 → 0.5.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MmIxMjIyZWU2NTIyOTdmZDdlNzU2MjBiM2NlNDU2MmFhMjJlNzVhNQ==
+    MmJlNGEzMjNhZjMyOTYyZWVkYmM2NjhhNGEwZDAwZmY0ODk4MWRkNQ==
   data.tar.gz: !binary |-
-    MDJmNTM0YzI1ZmY1OTM3NDM4NTczNDYxNWZjOWI0NjU1NzNlYzY2Mg==
+    OGVjNGUzNDY5YTQxZmQzMzgxMDJmMWM4OGUxNmRhMjE1NWY2YzQ3Mw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    M2Q3MDc2NWJmNDI1NDM3Y2M1YjNkNjgwN2JlMWY3M2M5ZjhmYWZmMTY4Njdk
-    MzViMjE0NDY1ZDlmOTNkNzBkNWI1MzgwNWFmYWYyM2YzOWE3YTE5YjcyZTg4
-    YzM5ZWZkMDFjODBjMjBlN2Q0MDBiNDI5MzYyYWNhODZlZDQzNDU=
+    YmQ0Y2VkYTM2YTg1ZmRkNzBmODkxMGVhMDI3NTI2YzRkZmYwZTJjMzE5OTI3
+    Nzg0ZjRiMzU3ZTEzMTY5YTBiMjk4YjYzYzYzMWMwNjFlMmU2MzI3MTdhZDQ5
+    OGUyODNhMTc4YTA3ZDYzYjVlOTc5ZGY1Y2UzZTk4MzJlM2U0YzI=
   data.tar.gz: !binary |-
-    YWJmZDEwMzlhMzkxZWJlMDZjOTZlZDRkNzM4MTMyZDBlZTlkZmM1NWUzOTMz
-    YWFkMjBlNjgzY2U2ZWQxYTg3ZThlODZkMGVkOWU3MzVjNTU2ODc5ZjYyMGQ2
-    YzJkNWFhYjRiY2EzZGI1YzE1OGQ5YzJkYzVjYTY0MWJiYjBmNmQ=
+    NzVmNzU1OWVlNjQ0NzNlNWM2MmVjZDc2NjU5OWQ5NWJlN2I0ZWRkZmY3Y2Q4
+    MTI1YzkyMDJhNDM2ZDBmN2ZmNmE4MzQxODc5MzhmZDEwNGFjOTE4MzFmYzA4
+    OTY3OGZlNjM5MDMxZGFhMzExZDRjZTRmOTNkMjZkYWFkOTA4Nzc=

data/.gitignore

@@ -2,7 +2,7 @@
 .bundle
 Gemfile.lock
 pkg/*
-.yardoc
-doc
 rake
 tmp
+.env
+*.db

data/.rspec

@@ -1,2 +1 @@
---color
---format=documentation
+--colour --format=Fivemat

data/.travis.yml

@@ -3,6 +3,6 @@ language: ruby
 rvm:
   - 1.9.3
   - 1.9.2
-  - 1.8.7
+  - 2.0.0
 
-script: "bundle exec rake spec"
+script: "echo 'COME ON!' && bundle exec rake spec"

data/README.md

@@ -92,7 +92,7 @@ user = User.new(:fullname => "Maeby Fünke")
 user.save
 ```
 
-You can look into the `examples` directory for sample applications using Her. For a complete reference of all the methods you can use, check out [the documentation](http://rdoc.info/github/remiprev/her).
+You can look into the `examples` directory for a sample application using Her. For a complete reference of all the methods you can use, check out [the documentation](http://rdoc.info/github/remiprev/her).
 
 ## Middleware
 
@@ -102,31 +102,23 @@ Since Her relies on [Faraday](https://github.com/technoweenie/faraday) to send H
 
 Her doesn’t support authentication by default. However, it’s easy to implement one with request middleware. Using the `connection` block, we can add it to the middleware stack.
 
-For example, to add a API token header to your requests in a Rails application, you would do something like this:
+For example, to add a token header to your API requests in a Rails application, you could use the excellent [`request_store`](https://rubygems.org/gems/request_store) gem like this:
 
 ```ruby
 # app/controllers/application_controller.rb
 class ApplicationController < ActionController::Base
-  around_filter :do_with_authenticated_user
-
-  def do_with_authenticated_user
-    Thread.current[:my_api_token] = session[:my_api_token]
-    begin
-      yield
-    ensure
-      Thread.current[:my_access_token] = nil
-    end
+  before_filter :set_user_api_token
+
+  protected
+  def set_user_api_token
+    RequestStore.store[:my_api_token] = current_user.api_token # or something similar based on `session`
   end
 end
 
 # lib/my_token_authentication.rb
 class MyTokenAuthentication < Faraday::Middleware
-  def initialize(app, options={})
-    @app = app
-  end
-
   def call(env)
-    env[:request_headers]["X-API-Token"] = Thread.current[:my_api_token] if Thread.current[:my_api_token].present?
+    env[:request_headers]["X-API-Token"] = RequestStore.store[:my_api_token]
     @app.call(env)
   end
 end
@@ -136,6 +128,7 @@ require "lib/my_token_authentication"
 
 Her::API.setup :url => "https://api.example.com" do |connection|
   connection.use MyTokenAuthentication
+  connection.use Faraday::Request::UrlEncoded
   connection.use Her::Middleware::DefaultParseJSON
   connection.use Faraday::Adapter::NetHttp
 end
@@ -781,6 +774,7 @@ These fine folks helped with Her:
 * [@joanniclaborde](https://github.com/joanniclaborde)
 * [@seanreads](https://github.com/seanreads)
 * [@jonkarna](https://github.com/jonkarna)
+* [@aclevy](https://github.com/aclevy)
 
 ## License
 

data/UPGRADE.md

@@ -2,6 +2,10 @@
 
 Here is a list of backward-incompatible changes that were introduced while Her is pre-1.0. After reaching 1.0, it will follow the [Semantic Versioning](http://semver.org/) system.
 
+## 0.5.4
+
+* Her does not support Ruby 1.8.7 anymore. You should upgrade to 1.9.2, 1.9.3 or 2.0.0.
+
 ## 0.5
 
 * Her is now compatible with `ActiveModel` and includes `ActiveModel::Validations`.

data/examples/grape-and-her/.env.default

@@ -0,0 +1,3 @@
+RACK_ENV=development
+API_PORT=3100
+CONSUMER_PORT=3200

data/examples/grape-and-her/Procfile

@@ -0,0 +1,2 @@
+api: ruby -C ./api -S bundle exec unicorn -p $API_PORT -c ./config/unicorn.rb -E $RACK_ENV
+consumer: ruby -C ./consumer -S bundle exec unicorn -p $CONSUMER_PORT -c ./config/unicorn.rb -E $RACK_ENV

data/examples/grape-and-her/README.md

@@ -0,0 +1,27 @@
+# Grape + Her example
+
+This is an example of how to use Her to consume a simple API. It consists of two separate applications, a REST API (powered by `grape` and `activerecord`) and a consumer application (powered by `sinatra` and `her`).
+
+![](http://i.imgur.com/AGfYwzl.png)
+
+## Installation and Usage
+
+```shell
+# Clone the repository
+$ git clone git://github.com/remiprev/her.git
+
+# Go to the example directory
+$ cd her/examples/grape-and-her
+
+# Go to each application and run `bundle install`
+$ cd api; bundle install; cd ..
+$ cd consumer; bundle install; cd ..
+
+# Create the API database
+$ cd api; sqlite3 db/development.db ""; bundle exec rake db:migrate; cd ..
+
+# Start foreman with the Procfile
+$ foreman start
+```
+
+This should start the API on `http://0.0.0.0:3100` and the consumer on `http://0.0.0.0:3200`

data/examples/grape-and-her/api/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Server
+gem 'unicorn'
+
+# App
+gem 'grape'
+gem 'sqlite3'
+gem 'activerecord', '~> 3.2'
+gem 'portugal'
+gem 'grape-rabl'

data/examples/grape-and-her/api/Rakefile

@@ -0,0 +1,14 @@
+require 'portugal/tasks'
+Portugal.configure do |config|
+  config.migrations_path = File.expand_path("../db/migrations", __FILE__)
+end
+
+# This task is called before Portugal executes its tasks.
+# It should require ActiveRecord somehow and establish the database connection
+#
+# Change it so it works for your application
+task :environment do
+  require 'bundler'
+  Bundler.require
+  ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: File.expand_path('../db/development.db', __FILE__)
+end

data/examples/grape-and-her/api/app/api.rb

@@ -0,0 +1,49 @@
+class API < Grape::API
+  content_type :json, "application/json; charset=UTF-8"
+  format :json
+  formatter :json, Grape::Formatter::Rabl
+  use(Rack::Config) { |env| env['api.tilt.root'] = File.expand_path('../views',  __FILE__) }
+  rescue_from :all
+
+  resources :users do
+    desc 'Return all users'
+    get nil, :rabl => "users/index" do
+      @users = User.all
+    end
+
+    desc 'Return a specific user'
+    get ':id', :rabl => "users/show" do
+      @user = User.find(params[:id])
+    end
+
+    desc 'Create a new user'
+    post nil, :rabl => "users/show" do
+      @user = User.new(params[:user])
+      error!({ :errors => @user.errors.full_messages }, 400) unless @user.save
+    end
+  end
+
+  resources :organizations do
+    desc 'Return all organizations'
+    get nil, :rabl => "organizations/index" do
+      @organizations = Organization.all
+    end
+
+    desc 'Return a specific organization'
+    get ':id', :rabl => "organizations/show" do
+      @organization = Organization.find(params[:id])
+    end
+
+    desc 'Return all users for specific organization'
+    get ':id/users', :rabl => "users/index" do
+      organization = Organization.find(params[:id])
+      @users = organization.users
+    end
+
+    desc 'Create a new organization'
+    post nil, :rabl => "organizations/show" do
+      @organization = Organization.new(params[:organization])
+      error!({ :errors => @organization.errors.full_messages }, 400) unless @organization.save
+    end
+  end
+end

data/examples/grape-and-her/api/app/models/organization.rb

@@ -0,0 +1,7 @@
+class Organization < ActiveRecord::Base
+  # Associations
+  has_many :users
+
+  # Validations
+  validates :name, presence: true
+end

data/examples/grape-and-her/api/app/models/user.rb

@@ -0,0 +1,9 @@
+class User < ActiveRecord::Base
+  # Associations
+  belongs_to :organization
+
+  # Validations
+  validates :email, presence: true
+  validates :fullname, presence: true
+  validates :organization, presence: true
+end

data/examples/grape-and-her/api/app/views/organizations/_base.rabl

@@ -0,0 +1,2 @@
+attribute :id
+attribute :name

data/examples/grape-and-her/api/app/views/organizations/index.rabl

@@ -0,0 +1,3 @@
+collection @organizations
+
+extends("organizations/base")

data/examples/grape-and-her/api/app/views/organizations/show.rabl

@@ -0,0 +1,3 @@
+object @organization
+
+extends("organizations/base")

data/examples/grape-and-her/api/app/views/users/_base.rabl

@@ -0,0 +1,8 @@
+attribute :id
+attribute :email
+attribute :fullname
+attribute :organization_id
+
+child :organization do
+  extends("organizations/base")
+end

data/examples/grape-and-her/api/app/views/users/index.rabl

@@ -0,0 +1,3 @@
+collection @users
+
+extends("users/base")

data/examples/grape-and-her/api/app/views/users/show.rabl

@@ -0,0 +1,3 @@
+object @user
+
+extends("users/base")

data/examples/grape-and-her/api/config.ru

@@ -0,0 +1,5 @@
+require File.expand_path('../config/boot',  __FILE__)
+
+map "/" do
+  run API
+end

data/examples/grape-and-her/api/config/boot.rb

@@ -0,0 +1,17 @@
+# Bundler setup
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+Bundler.require(:default, ENV['RACK_ENV']) if defined? Bundler
+
+# Configure ActiveRecord
+ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: File.expand_path('../../db/development.db', __FILE__)
+
+# Require models
+Dir[File.expand_path('../../app/models/**/*.rb', __FILE__)].each do |file|
+  dirname = File.dirname(file)
+  file_basename = File.basename(file, File.extname(file))
+  require "#{dirname}/#{file_basename}"
+end
+
+# Application setup
+require File.expand_path('../../app/api',  __FILE__)

data/examples/grape-and-her/api/config/unicorn.rb

@@ -0,0 +1,7 @@
+if ENV["RACK_ENV"] == "development"
+  worker_processes 1
+else
+  worker_processes 4
+end
+
+timeout 30

data/examples/grape-and-her/api/db/migrations/001_create_users.rb

@@ -0,0 +1,11 @@
+class CreateUsers < ActiveRecord::Migration
+  def change
+    create_table :users do |t|
+      t.string :email
+      t.string :fullname
+      t.integer :organization_id, null: false
+
+      t.timestamps
+    end
+  end
+end

data/examples/grape-and-her/api/db/migrations/002_create_organizations.rb

@@ -0,0 +1,8 @@
+class CreateOrganizations < ActiveRecord::Migration
+  def change
+    create_table :organizations do |t|
+      t.string :name
+      t.timestamps
+    end
+  end
+end

data/examples/grape-and-her/consumer/Gemfile

@@ -0,0 +1,23 @@
+source 'https://rubygems.org'
+
+# Server
+gem 'unicorn'
+
+# Web
+gem 'sinatra'
+gem 'sinatra-reloader'
+gem 'haml'
+gem 'her'
+gem 'multi_json'
+
+# Assets
+gem 'sass'
+gem 'sprockets'
+gem 'sprockets-sass'
+gem 'sprockets-helpers'
+
+group :development do
+  gem 'pry'
+  gem 'rake'
+  gem 'foreman'
+end

data/examples/grape-and-her/consumer/app/assets/stylesheets/application.scss

@@ -0,0 +1,190 @@
+@import "reset.css";
+
+* {
+  -webkit-box-sizing: border-box;
+  -moz-box-sizing: border-box;
+  box-sizing: border-box;
+}
+
+html {
+  font-size: 62.5%;
+}
+
+body {
+  background: #eee;
+  color: #000;
+  padding: 30px;
+  font-family: 'Helvetica Neue', Helvetica, sans-serif;
+  font-size: 150%;
+}
+
+input, textarea, select, option, button {
+  font-family: 'Helvetica Neue', Helvetica, sans-serif;
+  font-size: 100%;
+}
+
+hr {
+  display: none;
+}
+
+a {
+  color: #1b49ff;
+}
+
+#wrap {
+  background: #fff;
+  box-shadow: 0 0 20px rgba(0,0,0,0.3);
+  border: 1px solid #bbb;
+  border-radius: 4px;
+  overflow:hidden;
+}
+
+#main-header {
+  font-size: 130%;
+  background: #ddd;
+
+  strong {
+    font-family: Pacifico, serif;
+    font-size: 250%;
+    font-weight: normal;
+    display: inline-block;
+    vertical-align: middle;
+  }
+
+  span {
+    display: inline-block;
+    vertical-align: middle;
+    color: rgba(0,0,0,0.4);
+    font-weight: normal;
+    margin: 0 0 0 20px;
+    font-size: 80%;
+  }
+
+  a {
+    display: block;
+    padding: 30px 20px;
+    color: #000;
+    text-decoration: none;
+
+    &:hover {
+      background: rgba(0,0,0,0.05);
+    }
+  }
+}
+
+#main-footer {
+  pre {
+    padding: 20px;
+    color: rgba(0,0,0,0.75);
+    line-height: 1.4;
+    font-size: 80%;
+  }
+}
+
+#content {
+  padding: 30px;
+
+  h1 {
+    margin: 25px 0 15px;
+    font-size: 150%;
+    &:first-child { margin-top: 0; }
+  }
+
+  h2 {
+    margin: 25px 0 15px;
+    font-size: 120%;
+    &:first-child { margin-top: 0; }
+  }
+
+  h3 {
+    margin: 25px 0 15px;
+    font-size: 110%;
+    &:first-child { margin-top: 0; }
+  }
+
+  pre {
+    background: #f9ffeb;
+    border: 1px solid rgba(0,0,0,0.15);
+    padding: 15px;
+  }
+
+  form {
+    margin: 0 0 15px;
+    padding: 0 0 15px;
+    border-bottom: 1px solid #ddd;
+
+    p {
+      margin: 0 0 15px;
+    }
+
+    label {
+      display: block;
+      margin: 0 0 6px;
+      cursor: pointer;
+    }
+
+    input[type=text], input[type=email] {
+      padding: 10px;
+      width: 100%;
+      border: 1px solid #ccc;
+      border-radius: 2px;
+    }
+
+    button {
+      cursor: pointer;
+      background: #1b49ff;
+      color: #fff;
+      padding: 8px 11px;
+      border-radius: 3px;
+      border: 1px solid rgba(0,0,0,0.3);
+    }
+
+    .errors {
+      padding: 15px;
+      background: #fcc;
+      border: 1px solid rgba(0,0,0,0.2);
+      margin: 0 0 20px;
+      font-size: 90%;
+      color: #900;
+
+      li {
+        margin: 0 0 5px 20px;
+        list-style: disc;
+        &:last-child { margin-bottom: 0; }
+      }
+    }
+  }
+
+  .records {
+    li {
+      list-style: disc;
+      margin: 0 0 10px 20px;
+
+      &:last-child { margin-bottom: 0; }
+    }
+  }
+
+  .no-records {
+    color: rgba(0,0,0,0.8);
+    font-style: italic;
+    font-size: 80%;
+  }
+
+  .details {
+    margin: 0 0 20px;
+
+    li {
+      list-style: disc;
+      margin: 0 0 6px 20px;
+
+      &:last-child { margin-bottom: 0; }
+    }
+  }
+
+  .back {
+    border-top: 1px solid #ddd;
+    padding: 15px 0 0;
+    margin: 30px 0 0;
+    font-size: 85%;
+  }
+}