sawyer 0.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2011 rick olson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,17 @@
+# Sawyer
+
+Sawyer is an experimental secret user agent built on top of
+[Faraday][faraday].
+
+![](http://techno-weenie.net/sawyer/images/faraday.jpeg)
+
+Think of Faraday as the nerdy scientist behind an HTTP API.  Sure, he
+knows the technical details of how to communicate with an application.
+But he also gets overly obsessive about alternate timelines to be of
+much use.
+
+![](http://techno-weenie.net/sawyer/images/sawyer.jpeg)
+
+Sawyer knows what needs to be done.  He gets in there, assesses the
+situation, and figures out the next action.
+

data/Rakefile

@@ -0,0 +1,135 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end
+

data/SPEC.md

@@ -0,0 +1,71 @@
+# Sawyer
+
+To use Sawyer, create a new Agent with a URL endpoint.
+
+```ruby
+endpoint = "http://my-api.com"
+agent    = Sawyer::Agent.new endpoint do |conn|
+  conn.headers['content-type'] = 'application/vnd.my-api+json'
+end
+```
+
+From here, we can access the root to get the initial actions.
+
+```ruby
+root = agent.start
+```
+
+Every request in Sawyer returns a Sawyer::Response.  It's very similar
+to a raw Faraday::Response, with a few extra methods.
+
+```ruby
+# HTTP Headers
+root.headers
+
+# HTTP status
+root.status
+
+# The JSON Schema
+root.schema
+
+# The link relations
+root.rels
+
+# The contents (probably empty from the root)
+root.data
+```
+
+Now, we can access a relation off the root resource.
+
+```ruby
+resource = root.data
+res = resource.rels[:users].call :query => {:sort => 'login'}
+
+# An array of users
+users = res.data
+```
+
+This call returns two types of relations: relations on the collection of
+users, and relations on each user.  You can access the collection
+resources from the response.
+
+```ruby
+# get the next page of users
+res2 = res.rels[:next].call
+
+# page 2 of the users collection
+res2.data
+```
+
+Each user has it's own relations too:
+
+```ruby
+# favorite the previous user
+users.each_with_index do |user, index|
+  res = user.rels[:favorite].call users[index-1]
+  if !res.success?
+    puts "#{user.name} could not favorite #{users[index-1].name}"
+  end
+end
+```
+

data/example/client.rb

@@ -0,0 +1,50 @@
+require File.expand_path("../../lib/sawyer", __FILE__)
+require 'faraday'
+require 'pp'
+
+endpoint = "http://localhost:9393/"
+agent    = Sawyer::Agent.new(endpoint) do |http|
+  http.headers['content-type'] = 'application/json'
+end
+puts agent.inspect
+puts
+
+root = agent.start
+puts root.inspect
+
+puts "LISTING USERS"
+users_rel = root.data.rels[:users]
+
+puts users_rel.inspect
+puts
+
+users_res = users_rel.get
+puts users_res.inspect
+
+users = users_res.data
+
+users.each do |user|
+  puts "#{user.login} favorites:"
+
+  fav_res = user.rels[:favorites].get
+
+  fav_res.data.each do |sushi|
+    puts "- #{sushi.inspect})"
+  end
+  puts
+end
+
+puts "CREATING USER"
+create_user_rel = root.data.rels[:users]
+
+puts create_user_rel.inspect
+
+created = create_user_rel.post(:login => 'booya')
+puts created.inspect
+puts
+
+puts "ADD A FAVORITE"
+created_user = created.data
+create_fav_res = created_user.rels[:favorites].post nil, :query => {:id => 1}
+puts create_fav_res.inspect
+

data/example/nigiri.schema.json

@@ -0,0 +1,47 @@
+{
+  "type": "object",
+  "relations": [
+    {"rel": "all", "href": "/nigiri"}
+  ],
+  "properties": {
+    "id": {
+      "type": "integer",
+      "minimum": 1,
+      "readonly": true
+    },
+    "name": {
+      "type": "string"
+    },
+    "fish": {
+      "type": "string"
+    },
+    "_links": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "rel": {
+            "type": "string"
+          },
+          "href": {
+            "type": "string",
+            "optional": true
+          },
+          "method": {
+            "type": "string",
+            "default": "get"
+          },
+          "schema": {
+            "type": "string",
+            "optional": true
+          }
+        },
+        "additionalProperties": false
+      },
+      "additionalProperties": false,
+      "readonly": true
+    }
+  }
+}
+
+

data/example/server.rb

@@ -0,0 +1,114 @@
+require 'sinatra'
+require 'yajl'
+
+get '/' do
+  app_type
+
+  Yajl.dump({
+    :_links => {
+      :users  => {:href => "/users", :method => 'get,post'},
+      :nigiri => {:href => "/nigiri"}
+    }
+  }, :pretty => true)
+end
+
+def app_type
+  content_type "application/vnd.sushihub+json"
+end
+
+users = [
+  {:id => 1, :login => 'sawyer',  :created_at => Time.utc(2004, 9, 22),
+   :_links => {
+     :self               => {:href => '/users/sawyer'},
+     :favorites          => {:href => '/users/sawyer/favorites', :method => 'get,post'}
+   }},
+  {:id => 2, :login => 'faraday', :created_at => Time.utc(2004, 12, 22),
+   :_links => {
+     :self               => {:href => '/users/faraday'},
+     :favorites          => {:href => '/users/faraday/favorites', :method => 'get,post'}
+   }}
+]
+
+nigiri = [
+  {:id => 1, :name => 'sake',  :fish => 'salmon',
+   :_links => {
+     :self => {:href => '/nigiri/sake'}
+   }},
+  {:id => 2, :name => 'unagi', :fish => 'eel',
+   :_links => {
+     :self => {:href => '/nigiri/unagi'}
+   }}
+]
+
+get '/users' do
+  app_type
+
+  Yajl.dump users, :pretty => true
+end
+
+new_users = {}
+post '/users' do
+  if env['CONTENT_TYPE'].to_s !~ /json/i
+    halt 400, "Needs JSON"
+  end
+
+  app_type
+
+  hash = Yajl.load request.body.read, :symbolize_keys => true
+  new_users[hash[:login]] = hash
+  
+  headers "Location" => "/users/#{hash[:login]}"
+  status 201
+  Yajl.dump hash.update(
+    :id => 3,
+    :created_at => Time.now.utc.xmlschema,
+    :_links => {
+      :self              => {:href => "/users/#{hash[:login]}"},
+      :favorites         => {:href => "/users/#{hash[:login]}/favorites", :method => 'get,post'}
+    }
+  ), :pretty => true
+end
+
+get '/users/:login' do
+  headers 'Content-Type' => app_type
+  if hash = users.detect { |u| u[:login] == params[:login] }
+    Yajl.dump hash, :pretty => true
+  else
+    halt 404
+  end
+end
+
+get '/users/:login/favorites' do
+  app_type
+
+  case params[:login]
+  when users[0][:login] then Yajl.dump([nigiri[0]], :pretty => true)
+  when users[1][:login] then Yajl.dump([], :pretty => true)
+  else halt 404
+  end
+end
+
+post '/users/:login/favorites' do
+  if params[:id].to_i > 0
+    halt 201
+  else
+    halt 422
+  end
+end
+
+get '/nigiri' do
+  app_type
+
+  Yajl.dump nigiri, :pretty => true
+end
+
+get '/nigiri/:name' do
+  app_type
+
+  if hash = nigiri.detect { |n| n[:name] == params[:name] }
+    Yajl.dump hash, :pretty => true
+  else
+    halt(404)
+  end
+end
+