cage 0.0.1 → 0.0.2

data/lib/cage.rb

@@ -1,6 +1,9 @@
 require "pry"
 require "awesome_print"
 require "faraday"
+require "multi_json"
+require "nokogiri"
 
 require "cage/version"
+require "cage/response"
 require "cage/console"

data/lib/cage/console.rb

@@ -1,38 +1,47 @@
 module Cage
   class Console
     CONNECTION_VARIABLES = [:scheme, :domain, :prefix, :headers]
+    HTTP_METHOD_REGEX = /^(?:get|post|put|delete)$/i
 
     attr_reader :connection, :last_response, *CONNECTION_VARIABLES
 
+
     def initialize
       @scheme = "http"
-      @domain = "duckduckgo.com"
-      @prefix = "?q="
+      @domain = "rubygems.org"
+      @prefix = "api/v1/gems/"
+      @headers = {}
       reinitialize_connection
     end
 
     def reinitialize_connection
-      @connection = Faraday::Connection.new "#{scheme}://#{domain}/#{prefix}"
+      @connection = Faraday::Connection.new "#{scheme}://#{domain}/#{prefix}",
+      :headers => @headers
     end
 
     def method_missing sym, *args, &block
-      if  sym =~ /^(?:get|post|put|delete)$/i
+      if  sym =~ HTTP_METHOD_REGEX
         http sym, *args, &block
       else
         super
       end
     end
 
-    def print_response
-      ap [ last_response.status, last_response.headers, last_response.body ]
+    def respond_to? method
+      if method =~ HTTP_METHOD_REGEX
+        true
+      else
+        super
+      end
     end
 
     def http method, *args, &block
-      @last_response = connection.send method, *args, &block
-      print_response
+      @last_response = Cage::Response.new connection.send method, *args, &block
     end
 
     def set convar, value
+      raise ArgumentError, "#{convar} isn't a connection variable" unless
+        CONNECTION_VARIABLES.include? convar
       instance_variable_set :"@#{convar}", value
       reinitialize_connection
       value

data/lib/cage/response.rb

@@ -0,0 +1,58 @@
+module Cage
+  class Response
+    JSON_MIME_REGEX = %r{(?:application/json|application/x-javascript|
+                          text/javascript|text/x-javascript|text/x-json)}x
+    XML_MIME_REGEX = %r{(?:application/xml|text/xml|application/atom)}x
+
+    def initialize faraday_response
+      @faraday_response = faraday_response
+    end
+
+    def body
+      @body ||= parsed_body
+    end
+
+    def status
+      @faraday_response.status
+    end
+
+    def headers
+      @faraday_response.headers
+    end
+
+    def parsed_body
+      case format_for @faraday_response.headers["content-type"]
+      when :json
+        MultiJson.decode @faraday_response.body
+      when :xml
+        Nokogiri::XML::Document.new @faraday_response.body
+      else
+        @faraday_response.body
+      end
+    end
+
+    def format_for content_type_string
+      case content_type_string
+      when JSON_MIME_REGEX
+        :json
+      when XML_MIME_REGEX
+        :xml
+      end
+    end
+
+    def inspect
+      <<-PRETTY
+
+Status: #{@faraday_response.status}
+
+Headers:
+#{@faraday_response.headers.map { |k, v| "  #{k}: #{v}" }.join "\n"}
+
+Body:
+  #{body}
+
+#<Cage::Response>
+      PRETTY
+    end
+  end
+end

data/lib/cage/version.rb

@@ -1,3 +1,3 @@
 module Cage
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/day9.xml

@@ -0,0 +1,9 @@
+<?xml version='1.0' encoding='UTF-8'?><entry xmlns='http://www.w3.org/2005/Atom' xmlns:media='http://search.yahoo.com/mrss/' xmlns:gd='http://schemas.google.com/g/2005' xmlns:yt='http://gdata.youtube.com/schemas/2007'><id>http://gdata.youtube.com/feeds/api/users/day9tv</id><published>2010-04-22T14:48:11.000-07:00</published><updated>2012-01-26T18:50:49.000-08:00</updated><category scheme='http://schemas.google.com/g/2005#kind' term='http://gdata.youtube.com/schemas/2007#userProfile'/><category scheme='http://gdata.youtube.com/schemas/2007/channeltypes.cat' term='Guru'/><title type='text'>day9tv</title><content type='text'>I've qualified for the WCG USA finals 7 times, the WCG Grand Finals 3 times, and won the Pan American Championship in 2007 for StarCraft. In StarCraft 2 I play as random.
+
+		I grew up playing Starcraft with my brother, Nick (Tasteless). With the launch of Starcraft 2, I'm dedicated to helping the eSports movement grow in popularity around the world.
+
+		Watch my video autobiography here: http://www.youtube.com/watch?v=NJztfsXKcPQ</content><link rel='alternate' type='text/html' href='http://www.youtube.com/profile?user=day9tv'/><link rel='http://gdata.youtube.com/schemas/2007#featured-video' type='application/atom+xml' href='http://gdata.youtube.com/feeds/api/videos/iCqwwTfXr1Q'/><link rel='related' type='text/html' href='http://day9.tv'/><link rel='self' type='application/atom+xml' href='http://gdata.youtube.com/feeds/api/users/day9tv'/><author><name>day9tv</name><uri>http://gdata.youtube.com/feeds/api/users/day9tv</uri></author><yt:age>26</yt:age><yt:description>I've qualified for the WCG USA finals 7 times, the WCG Grand Finals 3 times, and won the Pan American Championship in 2007 for StarCraft. In StarCraft 2 I play as random.
+
+		I grew up playing Starcraft with my brother, Nick (Tasteless). With the launch of Starcraft 2, I'm dedicated to helping the eSports movement grow in popularity around the world.
+
+		Watch my video autobiography here: http://www.youtube.com/watch?v=NJztfsXKcPQ</yt:description><gd:feedLink rel='http://gdata.youtube.com/schemas/2007#user.favorites' href='http://gdata.youtube.com/feeds/api/users/day9tv/favorites' countHint='3'/><gd:feedLink rel='http://gdata.youtube.com/schemas/2007#user.contacts' href='http://gdata.youtube.com/feeds/api/users/day9tv/contacts' countHint='1'/><gd:feedLink rel='http://gdata.youtube.com/schemas/2007#user.inbox' href='http://gdata.youtube.com/feeds/api/users/day9tv/inbox'/><gd:feedLink rel='http://gdata.youtube.com/schemas/2007#user.playlists' href='http://gdata.youtube.com/feeds/api/users/day9tv/playlists'/><gd:feedLink rel='http://gdata.youtube.com/schemas/2007#user.subscriptions' href='http://gdata.youtube.com/feeds/api/users/day9tv/subscriptions' countHint='12'/><gd:feedLink rel='http://gdata.youtube.com/schemas/2007#user.uploads' href='http://gdata.youtube.com/feeds/api/users/day9tv/uploads' countHint='1210'/><gd:feedLink rel='http://gdata.youtube.com/schemas/2007#user.newsubscriptionvideos' href='http://gdata.youtube.com/feeds/api/users/day9tv/newsubscriptionvideos'/><yt:firstName>Sean Day[9]</yt:firstName><yt:gender>m</yt:gender><yt:hobbies>Starcraft 2, Diablo 3, and other video games!</yt:hobbies><yt:hometown>Leawood, KS</yt:hometown><yt:lastName>Plott</yt:lastName><yt:location>Los Angeles, CA, US</yt:location><yt:occupation>Starcraft 2 Player and Commentator</yt:occupation><yt:school>Harvey Mudd College, USC</yt:school><yt:statistics lastWebAccess='2012-01-18T21:25:07.000-08:00' subscriberCount='250349' videoWatchCount='0' viewCount='12971336' totalUploadViews='38997604'/><media:thumbnail url='http://i2.ytimg.com/i/axar6TBM-94_ezoS00fLkA/1.jpg?v=4f172453'/><yt:username>day9tv</yt:username></entry>

data/test/rails-gem.json

@@ -0,0 +1 @@
+{"name":"rails","downloads":7400862,"version":"3.2.1","version_downloads":1836,"authors":"David Heinemeier Hansson","info":"Ruby on Rails is a full-stack web framework optimized for programmer happiness and sustainable productivity. It encourages beautiful code by favoring convention over configuration.","project_uri":"http://rubygems.org/gems/rails","gem_uri":"http://rubygems.org/gems/rails-3.2.1.gem","homepage_uri":"http://www.rubyonrails.org","wiki_uri":"http://wiki.rubyonrails.org","documentation_uri":"http://api.rubyonrails.org","mailing_list_uri":"http://groups.google.com/group/rubyonrails-talk","source_code_uri":"http://github.com/rails/rails","bug_tracker_uri":"http://github.com/rails/rails/issues","dependencies":{"development":[],"runtime":[{"name":"actionmailer","requirements":"= 3.2.1"},{"name":"actionpack","requirements":"= 3.2.1"},{"name":"activerecord","requirements":"= 3.2.1"},{"name":"activeresource","requirements":"= 3.2.1"},{"name":"activesupport","requirements":"= 3.2.1"},{"name":"bundler","requirements":"~> 1.0"},{"name":"railties","requirements":"= 3.2.1"}]}}

data/test/response_test.rb

@@ -0,0 +1,72 @@
+require "minitest/autorun"
+require "minitest/pride"
+require "multi_json"
+require "nokogiri"
+require "cage/response"
+
+describe Cage::Response do
+  let(:faraday_response) do
+    MiniTest::Mock.new
+  end
+  subject { Cage::Response.new faraday_response }
+
+  it "is created with a response as the constructor argument" do
+    subject.must_be_kind_of Cage::Response
+  end
+
+  describe "detects format from content type header" do
+    it "detects json" do
+      %w[application/json application/x-javascript text/javascript
+      text/x-javascript text/x-json].each do |json_content_type|
+        subject.format_for(json_content_type).must_equal :json
+      end
+    end
+
+    it "detects xml" do
+      %w[application/xml text/xml application/atom+xml].each do |xml_content_type|
+        subject.format_for(xml_content_type).must_equal :xml
+      end
+    end
+  end
+
+  describe "parses body text for known body types" do
+    let(:json_response) do
+      m = MiniTest::Mock.new
+      m.expect :headers, { "content-type" => "application/json" }
+      m.expect :body, File.read("test/rails-gem.json")
+    end
+
+    let(:xml_response) do
+      m = MiniTest::Mock.new
+      m.expect :headers, { "content-type" => "application/atom+xml; charset=UTF-8" }
+      m.expect :body, File.read("test/day9.xml")
+      m
+    end
+
+    let(:html_response) do
+      m = MiniTest::Mock.new
+      m.expect :headers, { "content-type" => "text/html" }
+      m.expect :body, <<-HTML
+<html>
+  <head><title>Win</title></head>
+  <body>Win</body>
+</html>
+      HTML
+      m
+    end
+
+    it "parses JSON into a hash" do
+      Cage::Response.new(json_response).body.must_be_instance_of Hash
+    end
+
+    it "parses XML into a Nokogiri::XML::Document" do
+      Cage::Response.new(xml_response).body.must_be_instance_of(
+        Nokogiri::XML::Document)
+    end
+
+    it "keeps the original body string when the filetype isn't detected" do
+      Cage::Response.new(html_response).body.must_be_instance_of String
+    end
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cage
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-26 00:00:00.000000000 Z
+date: 2012-01-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &7681480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7681480
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &10129200 !ruby/object:Gem::Requirement
+  requirement: &7681040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +32,32 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10129200
+  version_requirements: *7681040
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: &7680620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7680620
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &10126820 !ruby/object:Gem::Requirement
+  requirement: &7680200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *7680200
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &7679780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +65,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *10126820
+  version_requirements: *7679780
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &7679360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *7679360
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &10125360 !ruby/object:Gem::Requirement
+  requirement: &7678940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +87,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *10125360
+  version_requirements: *7678940
 - !ruby/object:Gem::Dependency
   name: awesome_print
-  requirement: &10124020 !ruby/object:Gem::Requirement
+  requirement: &7678520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +98,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *10124020
+  version_requirements: *7678520
 description: ! 'Curl can be a bit unfriendly, especially to developers just starting
   out. Cage
 
@@ -70,15 +114,14 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- Gemfile
-- README.md
-- Rakefile
-- bin/cage
-- cage.gemspec
 - lib/cage.rb
 - lib/cage/console.rb
 - lib/cage/version.rb
+- lib/cage/response.rb
+- test/day9.xml
+- test/rails-gem.json
+- test/response_test.rb
+- bin/cage
 homepage: https://github.com/nuclearsandwich/cage
 licenses: []
 post_install_message: 
@@ -103,4 +146,7 @@ rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: A Faraday Cage for your HTTP Interactions.
-test_files: []
+test_files:
+- test/day9.xml
+- test/rails-gem.json
+- test/response_test.rb

data/.gitignore

@@ -1,4 +0,0 @@
-*.gem
-.bundle
-Gemfile.lock
-pkg/*

data/Gemfile

@@ -1,4 +0,0 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in cage.gemspec
-gemspec

data/README.md

@@ -1,75 +0,0 @@
-Cage
-====
-
-*A Faraday Cage for your HTTP Interactions.*
-
-
-Getting It
-----------
-
-Once Cage hits 0.1.0, it will be released as a gem. Then you can install it
-globally with `gem install cage`. Better still, add it to the `Gemfile` of your
-project.
-
-```ruby
-group :development do
-  gem "cage"
-end
-```
-
-Using It
---------
-
-Running `cage` will begin a console session. Cage is like a specialized IRB, but
-for HTTP interactions. Imagine that you are working on an API. [Rack::Test][rt]
-is an awesome tool but when you try to use it interactively you get an
-interesting display of fireworks(read: stacktraces). Cage is based on a utility
-script I wrote while working on a REST API. Some days, you just want to monkey
-around with your work.
-
-When you run Cage, you're dropped into a special Pry terminal with HTTP related
-commands available.
-
-```
-[
-    [0] 200,
-    [1] {
-                   "server" => "nginx",
-                     "date" => "Thu, 26 Jan 2012 19:56:30 GMT",
-             "content-type" => "application/x-javascript; charset=UTF-8",
-        "transfer-encoding" => "chunked",
-               "connection" => "close",
-                  "expires" => "Thu, 26 Jan 2012 19:56:31 GMT",
-            "cache-control" => "max-age=1"
-    },
-    [2] "{\"Definition\":\"Hackers do *not* generally use this to mean FUBAR..."
-]
-```
-
-Configuring It
---------------
-
-Cage will look first for a global `~/.cagerc.rb` file, then for a localr
-`./cagerc.rb` in the working directory. Both are essentially instance_eval'd
-into your new Cage console so anything that works in Cage will work in a config.
-The global one is run first, so you can overload it with a local config. The
-local config is for setting up project defaults, you can even automate your
-initial authentication if you want.
-
-Roadmap
--------
-
-- 0.0.1 Have a working, if ugly and hacky console.
-
-- 0.0.2 Write tests for whatever I can.
-
-- 0.1.0 Clean up the prompt and solidify the command set. Support .cagerc files.
-
-- 0.2.0 Use decorators to pretty print responses.
-
-- 0.3.0 Auto detect and parse incoming body types like XML, JSON, wwwurlencode.
-
-- 0.4.0 Make it easier to send XML, YAML, and JSON formatted bodies.
-
-- 0.5.0 ???
-

data/Rakefile

@@ -1 +0,0 @@
-require "bundler/gem_tasks"

data/cage.gemspec

@@ -1,27 +0,0 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "cage/version"
-
-Gem::Specification.new do |s|
-  s.name        = "cage"
-  s.version     = Cage::VERSION
-  s.authors     = ["Steven! Ragnarök"]
-  s.email       = ["steven@nuclearsandwich.com"]
-  s.homepage    = "https://github.com/nuclearsandwich/cage"
-  s.summary     = "A Faraday Cage for your HTTP Interactions."
-  s.description = <<-DESC
-Curl can be a bit unfriendly, especially to developers just starting out. Cage
-wraps Faraday and Pry in order to provide an attractive and helpful interface to
-the web APIs in your life.
-  DESC
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-
-  s.add_development_dependency "minitest"
-  s.add_runtime_dependency "faraday"
-  s.add_runtime_dependency "pry"
-  s.add_runtime_dependency "awesome_print"
-end