jsonorama 0.1.0

data/.gitignore

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

data/Gemfile

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

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/jsonorama.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "jsonorama/version"
+
+Gem::Specification.new do |s|
+  s.name        = "jsonorama"
+  s.version     = Jsonorama::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Sam Taylor"]
+  s.email       = ["sjltaylor@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{for helping out with json apis}
+  #s.description = %q{TODO: Write a gem description}
+
+  s.rubyforge_project = "jsonorama"
+  
+  s.add_dependency 'blobject'
+  s.add_dependency 'rack'
+  
+
+  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"]
+end

data/lib/jsonorama/controller_support.rb

@@ -0,0 +1,53 @@
+module Jsonorama
+  module ControllerSupport
+  
+  protected  
+    # 'status': HTTP Response Status Code, response is an optional Blobject
+    def json_api_response(status, response=Jsonorama.json_response)
+      response.status_code = Rack::Utils.status_code status      
+      yield response if block_given?
+      respond_to do |format|
+        format.json do
+           render :json => response, :status => status
+           # don't return a head, difficult to handle in clientside ajax
+        end
+      end
+    end 
+
+    # if a block is given is will be passed (model, valid?, omg_api_response, rails_response_hash)
+    # the rails response hash allows the status code and json object to be modified
+    # usage:
+    # respond_to_api_post(model) do |model, valid, r, h|
+    # if valid
+    #   do_some_business_logic
+    #   # modifiy the status code (just for example)
+    #   h[:status]=201 
+    # else
+    #   # set an error message in the api response
+    #   r.message = 'model was invalid. you silly sausage'
+    # end
+    # end
+    def respond_to_api_post active_model
+      r = Jsonorama.json_response
+      h = {:json => r}
+
+      if active_model.valid?
+        h[:status] = :ok # HTTP 200
+        yield active_model, true, r, h if block_given?
+      else
+        r.errors = active_model.errors
+        h[:status] = :bad_request # HTTP 400
+        yield active_model, false, r, h if block_given?
+      end
+            
+      r.status_code = Rack::Utils.status_code h[:status]
+      
+      respond_to do |format|
+        format.json do
+           render h
+           # don't return a head, difficult to handle in clientside ajax
+        end
+      end
+    end
+  end                     
+end

data/lib/jsonorama/exception.rb

@@ -0,0 +1,5 @@
+class Exception
+  def as_json
+    {:class_name => self.class.name.to_s, :message => self.message, :backtrace => self.backtrace}    
+  end
+end

data/lib/jsonorama/json_client.rb

@@ -0,0 +1,112 @@
+require 'net/http'
+require 'uri'
+
+module Jsonorama 
+  class JsonClient
+    class ClientError < Exception; end
+    class ServerError < Exception; end
+    
+  protected
+    
+    def process_response http_response, options
+      c = http_response.code
+      case
+      when c.starts_with?('4') then
+        raise ClientError.new "HTTP:#{c}. #{http_response.message}" if options[:client_error]==:raise
+      when c.starts_with?('5') then
+        raise ServerError.new "HTTP:#{c}. #{http_response.message}" if options[:server_error]==:raise
+      else
+        json_response = Blobject.from_json http_response.body if http_response.body && (http_response.content_type=='application/json')
+        
+        json_response.defrost
+        
+        json_response ||= Api.json_response
+        json_response.status ||= c.to_i
+        json_response.message ||= http_response.message
+        
+        json_response.freeze
+        json_response.data.freeze
+        
+        return json_response 
+      end
+    end
+    
+    def handle_exception exception, options
+      raise exception if options[:exception]==:raise
+      r = Jsonorama.json_response
+      r.exception = exception
+      r
+    end
+    
+    def api_client_version
+      v = Version.get
+      return false if v=='0.0.0'
+      v
+    end
+    
+    def query_string
+      if api_client_version
+        sprintf('?%s', {:api_client_version => api_client_version}.to_query) 
+      else
+        ''
+      end
+    end
+    
+    def default_options
+      {
+        # how to handle different sorts of error. :return returns data with raising an exception, :raise raises an exception
+        :exception => :raise, # an error building the request or getting a response
+        :client_error => :raise, #4XX errors
+        :server_error => :raise, #5XX errors      
+      }
+    end
+    
+  public  
+    attr_accessor :host  
+  
+    def initialize host
+      self.host = host
+    end
+    
+    def uri path
+      
+      extension = ''
+      extension = '.json' if path.downcase.match(/\.json$/).blank?      
+      
+      uri = URI.join(
+        self.host, 
+        "#{path}#{extension}#{query_string}")
+      uri
+    end
+    
+    def get path, options={}
+      options = default_options.merge options
+      
+      begin
+        uri = uri path
+        http = Net::HTTP.new(uri.host, uri.port)
+        http_request = Net::HTTP::Get.new(uri.request_uri)
+        http_response = http.request(http_request)
+        process_response http_response, options
+      rescue Exception => e
+        handle_exception e, options
+      end        
+    end
+    
+    def post path, data, options={}
+      options = default_options.merge options 
+      
+      begin
+        uri = uri path
+        http = Net::HTTP.new(uri.host, uri.port)
+        http_request = Net::HTTP::Post.new(uri.request_uri)
+        http_request.set_form_data :json => ActiveSupport::JSON.encode(data)
+        http_response = http.request(http_request)
+        process_response http_response, options
+      rescue Exception => e
+        handle_exception e, options
+      end
+    end
+    
+  end
+end

data/lib/jsonorama/json_response.rb

@@ -0,0 +1,24 @@
+module Jsonorama
+  class JsonResponse
+    
+    attr_accessor :message, :errors, :data, :exception, :status_code
+    
+    def initialize
+      self.message = nil
+      self.errors = nil
+      self.data = Blobject.new
+      self.exception = nil
+      self.status_code = nil
+      yield self if block_given?
+      self
+    end
+  
+    def client_error?
+      self.status_code.to_s.starts_with? '4'
+    end
+    
+    def server_error?
+      self.status_code.to_s.starts_with? '5'
+    end
+  end
+end

data/lib/jsonorama/version.rb

@@ -0,0 +1,3 @@
+module Jsonorama
+  VERSION = "0.1.0"
+end

data/lib/jsonorama.rb

@@ -0,0 +1,10 @@
+Dir["lib/jsonorama/*.rb"].each {|file| require "./#{file}" }  
+
+module Jsonorama 
+  #use on server and client to marshal to/from json
+   def self.json_response
+     r = Api::JsonResponse.new
+     yield r if block_given?
+     r
+   end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: jsonorama
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Sam Taylor
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-12 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: blobject
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: 
+email: 
+- sjltaylor@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- jsonorama.gemspec
+- lib/jsonorama.rb
+- lib/jsonorama/controller_support.rb
+- lib/jsonorama/exception.rb
+- lib/jsonorama/json_client.rb
+- lib/jsonorama/json_response.rb
+- lib/jsonorama/version.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: jsonorama
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: for helping out with json apis
+test_files: []
+