urtak 0.9.7 → 0.9.8

data/.gitignore

@@ -2,4 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
-spec/fixtures/*
+spec/fixtures/*
+*.log

data/lib/urtak.rb

@@ -12,7 +12,7 @@ module Urtak
   end
   
   class Api
-    attr_accessor :options
+    attr_accessor :options, :logger
     
     def initialize(user_options = {})
       @options = {
@@ -26,31 +26,40 @@ module Urtak
       }.merge(user_options.select{|k,v|!v.nil?})
     end
     
+    def enable_logger(path)
+      require 'logger'
+      RestClient.log = @logger = Logger.new(path)
+    end
+    
+    def log(level, message)
+      @logger.send(level, message) if @logger
+    end
+    
     # ACCOUNTS
     def get_account(id)
-      Response.new(fire(:get, "accounts/#{id}"))
+      create_response(fire(:get, "accounts/#{id}"))
     end
     
     def create_account(attributes)
-      Response.new(fire(:post, "accounts", {:account => attributes}))
+      create_response(fire(:post, "accounts", {:account => attributes}))
     end
     
     # PUBLICATIONS
     def get_publication(key = options[:publication_key])
-      Response.new(fire(:get, "publications/#{key}"))
+      create_response(fire(:get, "publications/#{key}"))
     end
     
     def create_publication(attributes)
-      Response.new(fire(:post, "publications", {:publication => attributes}))
+      create_response(fire(:post, "publications", {:publication => attributes}))
     end
     
     def update_publication(key, attributes)
-      Response.new(fire(:put, "publications/#{key}", {:publication => attributes}))
+      create_response(fire(:put, "publications/#{key}", {:publication => attributes}))
     end
     
     # URTAKS
     def list_urtaks(options = {})
-      Response.new(fire(:get, "urtaks", options))
+      create_response(fire(:get, "urtaks", options))
     end
 
     def get_urtak(property, value, options = {})
@@ -62,11 +71,11 @@ module Urtak
         path = "urtaks/hash/#{Digest::SHA1.hexdigest(value)}"
       end
       
-      Response.new(fire(:get, path, options))
+      create_response(fire(:get, path, options))
     end
     
     def create_urtak(urtak_attributes, questions=[])
-      Response.new(fire(:post, 'urtaks', {:urtak => urtak_attributes.merge(:questions => questions)}))
+      create_response(fire(:post, 'urtaks', {:urtak => urtak_attributes.merge(:questions => questions)}))
     end
     
     def update_urtak(property, attributes)
@@ -80,7 +89,7 @@ module Urtak
         path = "urtaks/hash/#{Digest::SHA1.hexdigest(value)}"
       end
       
-      Response.new(fire(:put, path, {:urtak => attributes}))
+      create_response(fire(:put, path, {:urtak => attributes}))
     end
     
     # URTAK QUESTIONS
@@ -93,7 +102,7 @@ module Urtak
         path = "urtaks/hash/#{Digest::SHA1.hexdigest(value)}/questions"
       end
       
-      Response.new(fire(:get, path, options))
+      create_response(fire(:get, path, options))
     end
     
     def get_urtak_question(property, value, id, options = {})
@@ -105,7 +114,7 @@ module Urtak
         path = "urtaks/hash/#{Digest::SHA1.hexdigest(value)}/questions/#{id}"
       end
 
-      Response.new(fire(:get, path, options))
+      create_response(fire(:get, path, options))
     end
     
     def create_urtak_question(property, value, question)
@@ -117,7 +126,7 @@ module Urtak
         path = "urtaks/hash/#{Digest::SHA1.hexdigest(value)}/questions"
       end
 
-      Response.new(fire(:post, path, {:question => question}))
+      create_response(fire(:post, path, {:question => question}))
     end
     
     def approve_urtak_question(property, value, id)
@@ -129,7 +138,7 @@ module Urtak
         path = "urtaks/hash/#{Digest::SHA1.hexdigest(value)}/questions/#{id}/approve"
       end
 
-      Response.new(fire(:put, path))
+      create_response(fire(:put, path))
     end
     
     def reject_urtak_question(property, value, id)
@@ -141,7 +150,7 @@ module Urtak
         path = "urtaks/hash/#{Digest::SHA1.hexdigest(value)}/questions/#{id}/reject"
       end
 
-      Response.new(fire(:put, path))
+      create_response(fire(:put, path))
     end
     
     def spam_urtak_question(property, value, id)
@@ -153,7 +162,7 @@ module Urtak
         path = "urtaks/hash/#{Digest::SHA1.hexdigest(value)}/questions/#{id}/spam"
       end
 
-      Response.new(fire(:put, path))
+      create_response(fire(:put, path))
     end
     
     def ham_urtak_question(property, value, id)
@@ -165,20 +174,41 @@ module Urtak
         path = "urtaks/hash/#{Digest::SHA1.hexdigest(value)}/questions/#{id}/ham"
       end
 
-      Response.new(fire(:put, path))
+      create_response(fire(:put, path))
     end
     
     # QUESTIONS
     def list_questions(options={})
-      Response.new(fire(:get, "questions", options))
+      create_response(fire(:get, "questions", options))
     end
 
     def get_question(id)
-      Response.new(fire(:get, "questions/#{id}"))
+      create_response(fire(:get, "questions/#{id}"))
     end
     
     
     private
+    def create_response(raw)
+      response = Response.new(raw)
+      
+      # Now entering the Republic of Hackistan
+      if self.logger
+        relevant_headers = ["content-type", "location", "content-length", "etag"]
+        log_response = []
+        log_response << "\n"
+        log_response << "HTTP/1.1 #{response.code} #{response.raw.net_http_res.message}"
+        response.raw.net_http_res.each_header do |h,v|
+          next unless relevant_headers.include?(h)
+          log_response << "#{h.capitalize}: #{v}"
+        end
+        log_response << (response.format.eql?("JSON") ? JSON.pretty_generate(response.body) : "")
+        log_response << "\n"
+        log(:debug, log_response.join("\n"))
+      end
+      
+      return response
+    end
+    
     def fire(method, path, data={})
       if method == :get
         RestClient.get("#{options[:api_base]}/#{path}", 
@@ -229,18 +259,21 @@ module Urtak
   end
 
   class Response
-    attr_accessor :raw, :body
+    attr_accessor :raw, :body, :format
     
     def initialize(response)
-      @raw = response
+      @raw    = response
+      @format = nil
 
       # TODO case statement
-      if response.headers[:content_type].nil?
+      if response.headers[:content_type].nil? || response.body.empty?
         @body = response
       elsif response.headers[:content_type].match(/json/)
         @body = JSON.parse(response)
+        @format = "JSON"
       elsif response.headers[:content_type].match(/xml/)
         raise Urtak::Errors::Unimplemented
+        @format = "XML"
       else
         @body = response
       end

data/lib/urtak/version.rb

@@ -1,3 +1,3 @@
 module Urtak
-  VERSION = "0.9.7"
+  VERSION = "0.9.8"
 end

data/spec/base.rb

@@ -2,8 +2,6 @@ def is_ruby_19?
   RUBY_VERSION == '1.9.1' or RUBY_VERSION == '1.9.2'
 end
 
-Encoding.default_internal = Encoding.default_external = "ASCII-8BIT" if is_ruby_19?
-
 require 'rubygems'
 require 'rspec'
 require 'vcr'

data/spec/client_spec.rb

@@ -10,6 +10,9 @@ describe Urtak::Api do
 
   before(:each) do
     @client = Urtak::Api.new(@settings)
+    @client.enable_logger(File.expand_path(File.join(File.dirname(__FILE__), 'client.log')))
+    # @client.logger.level = Logger::INFO
+    @client.logger.level = Logger::DEBUG
   end
 
   it "should form http requests with proper accept headers"
@@ -38,7 +41,6 @@ describe Urtak::Api do
   context "publications" do
     it "should create a publication" do
       VCR.use_cassette('create_publication') do
-        @client = Urtak::Api.new(@settings)
         publication = {
           :name     => "Fun with VCRs",
           :domains  => "knossos.local"
@@ -51,7 +53,6 @@ describe Urtak::Api do
 
     it "should find a publication" do
       VCR.use_cassette('get_publication', :match_requests_on => [:method, :host, :path]) do
-        @client = Urtak::Api.new(@settings)
         response = @client.get_publication(@settings[:publication_key])
         response.class.should eq(Urtak::Response)
         response.code.should eq(200)
@@ -60,7 +61,6 @@ describe Urtak::Api do
 
     it "should update a publication" do
       VCR.use_cassette('update_publication') do
-        @client = Urtak::Api.new(@settings)
         publication = {
           :name     => "Fun with VCRs",
           :domains  => "funwithvcrs.com"
@@ -74,7 +74,6 @@ describe Urtak::Api do
   context "urtaks" do
     it "should create an urtak" do
       VCR.use_cassette('create_urtak') do
-        @client = Urtak::Api.new(@settings)
         @post_id = Digest::SHA1.hexdigest("#{Time.now.to_i}")
         urtak = {
           :title      => "200 Fun Things to Do with Cassette Tape",
@@ -94,7 +93,6 @@ describe Urtak::Api do
 
     it "should list urtaks" do
       VCR.use_cassette('list_urtaks', :match_requests_on => [:method, :host, :path]) do
-        @client = Urtak::Api.new(@settings)
         response = @client.list_urtaks
         response.code.should eq(200)
         response.body['urtaks']['urtak'].class.should eq(Array)
@@ -103,12 +101,10 @@ describe Urtak::Api do
 
     it "should find an urtak by id" do
       VCR.use_cassette('list_urtaks', :match_requests_on => [:method, :host, :path]) do
-        @client = Urtak::Api.new(@settings)
         response = @client.list_urtaks
         @urtak = response.body['urtaks']['urtak'].last
 
         VCR.use_cassette('get_urtak_by_id', :match_requests_on => [:method, :host, :path]) do
-          @client = Urtak::Api.new(@settings)
           response = @client.get_urtak(:id, @urtak['id'])
           response.code.should eq(200)
         end
@@ -117,12 +113,10 @@ describe Urtak::Api do
 
     it "should find an urtak by permalink hash" do
       VCR.use_cassette('list_urtaks', :match_requests_on => [:method, :host, :path]) do
-        @client = Urtak::Api.new(@settings)
         response = @client.list_urtaks
         @urtak = response.body['urtaks']['urtak'].last
 
         VCR.use_cassette('get_urtak_by_permalink', :match_requests_on => [:method, :host, :path]) do
-          @client = Urtak::Api.new(@settings)
           response = @client.get_urtak(:permalink, @urtak['permalink'])
           response.code.should eq(200)
         end
@@ -131,12 +125,10 @@ describe Urtak::Api do
 
     it "should find an urtak by post_id" do
       VCR.use_cassette('list_urtaks', :match_requests_on => [:method, :host, :path]) do
-        @client = Urtak::Api.new(@settings)
         response = @client.list_urtaks
         @urtak = response.body['urtaks']['urtak'].last
 
         VCR.use_cassette('get_urtak_by_post_id', :match_requests_on => [:method, :host, :path]) do
-          @client = Urtak::Api.new(@settings)
           response = @client.get_urtak(:post_id, @urtak['post_id'])
           response.code.should eq(200)
         end
@@ -145,13 +137,10 @@ describe Urtak::Api do
 
     it "should update an urtak" do
       VCR.use_cassette('list_urtaks', :match_requests_on => [:method, :host, :path]) do
-        @client = Urtak::Api.new(@settings)
         response = @client.list_urtaks
         @urtak = response.body['urtaks']['urtak'].last
 
         VCR.use_cassette('update_urtak') do
-          @client = Urtak::Api.new(@settings)
-
           urtak = {
             :title      => "200 really fun things to do with a cassette tape",
             :post_id    => @urtak['post_id'],
@@ -169,7 +158,6 @@ describe Urtak::Api do
   context "urtak-questions" do
     before(:each) do
       VCR.use_cassette('list_urtaks', :match_requests_on => [:method, :host, :path]) do
-        @client = Urtak::Api.new(@settings)
         response = @client.list_urtaks
         @urtak = response.body['urtaks']['urtak'].last
       end
@@ -261,7 +249,6 @@ describe Urtak::Api do
   context "questions" do
     it "should list questions" do
       VCR.use_cassette('list_questions', :match_requests_on => [:method, :host, :path]) do
-        @client = Urtak::Api.new(@settings)
         response = @client.list_questions
         if ENV['ADMIN']
           response.code.should eq(200)
@@ -273,8 +260,6 @@ describe Urtak::Api do
 
     it "should find a question" do
       VCR.use_cassette('list_questions', :match_requests_on => [:method, :host, :path]) do
-        @client = Urtak::Api.new(@settings)
-
         VCR.use_cassette('get_question', :match_requests_on => [:method, :host, :path]) do
           if ENV['ADMIN']
             @question = @client.list_questions.body['questions']['question'].last

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: urtak
 version: !ruby/object:Gem::Version
-  version: 0.9.7
+  version: 0.9.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-01 00:00:00.000000000Z
+date: 2012-03-15 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70275140141100 !ruby/object:Gem::Requirement
+  requirement: &2154780820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70275140141100
+  version_requirements: *2154780820
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70275140140300 !ruby/object:Gem::Requirement
+  requirement: &2154780360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70275140140300
+  version_requirements: *2154780360
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70275140139520 !ruby/object:Gem::Requirement
+  requirement: &2154779920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70275140139520
+  version_requirements: *2154779920
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70275140139080 !ruby/object:Gem::Requirement
+  requirement: &2154779400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70275140139080
+  version_requirements: *2154779400
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70275140138640 !ruby/object:Gem::Requirement
+  requirement: &2154778900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70275140138640
+  version_requirements: *2154778900
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70275140138200 !ruby/object:Gem::Requirement
+  requirement: &2154778240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70275140138200
+  version_requirements: *2154778240
 description: Ruby Client for the Urtak REST API
 email:
 - kunal@urtak.com
@@ -113,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: urtak
-rubygems_version: 1.8.10
+rubygems_version: 1.8.9
 signing_key: 
 specification_version: 3
 summary: Ruby Client for the Urtak REST API