grendel-ruby 0.1.2 → 0.1.3

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/grendel-ruby.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{grendel-ruby}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brad Greenlee"]
-  s.date = %q{2010-04-27}
+  s.date = %q{2010-04-29}
   s.description = %q{Grendel is a RESTful web service which allows for the secure storage of users'
     documents. Grendel-Ruby provides a Ruby API for Grendel.}
   s.email = %q{brad@wesabe.com}
@@ -28,7 +28,6 @@ Gem::Specification.new do |s|
      "TODO.md",
      "VERSION",
      "grendel-ruby.gemspec",
-     "lib/core_ext/hash.rb",
      "lib/grendel.rb",
      "lib/grendel/client.rb",
      "lib/grendel/document.rb",
@@ -37,6 +36,7 @@ Gem::Specification.new do |s|
      "lib/grendel/link_manager.rb",
      "lib/grendel/linked_document.rb",
      "lib/grendel/linked_document_manager.rb",
+     "lib/grendel/mash.rb",
      "lib/grendel/user.rb",
      "lib/grendel/user_manager.rb",
      "spec/grendel/client_spec.rb",

data/lib/grendel.rb

@@ -3,8 +3,8 @@ $:.unshift File.dirname(__FILE__)
 require 'rubygems'
 require 'httparty'
 require 'json'
-require 'core_ext/hash'
 require 'mime/types'
+require 'grendel/mash'
 require 'grendel/client'
 require 'grendel/user_manager'
 require 'grendel/user'

data/lib/grendel/client.rb

@@ -12,53 +12,50 @@ module Grendel
     end
 
     def get(uri, options = {})
-      options.merge!(:debug_output => @debug_output) if @debug
-      response = HTTParty.get(@base_uri + uri, options)
-      raise HTTPException.new(response) if response.code >= 400
-      return response
+      process_response HTTParty.get(@base_uri + uri, process_options(options))
     end
 
     def head(uri, options = {})
-      options.merge!(:debug_output => @debug_output) if @debug
-      response = HTTParty.head(@base_uri + uri, options)
-      raise HTTPException.new(response) if response.code >= 400
-      return response
+      process_response HTTParty.head(@base_uri + uri, process_options(options))
     end
 
     def post(uri, data = {}, options = {})
-      data = data.to_json unless options.delete(:raw_data)
-      options.merge!(
-          :body => data,
-          :headers => {'Content-Type' => 'application/json'}
-      )
-      options.merge!(:debug_output => @debug_output) if @debug
-      response = HTTParty.post(@base_uri + uri, options)
-      raise HTTPException.new(response) if response.code >= 400
-      return response
+      process_response HTTParty.post(@base_uri + uri, process_options(options, data))
     end
 
     def put(uri, data = {}, options = {})
-      data = data.to_json unless options.delete(:raw_data)
-      options = {
-        :body => data,
-        :headers => {'Content-Type' => 'application/json'}
-      }.update(options)
-      options.merge!(:debug_output => @debug_output) if @debug
-      response = HTTParty.put(@base_uri + uri, options)
-      raise HTTPException.new(response) if response.code >= 400
-      return response
+      process_response HTTParty.put(@base_uri + uri, process_options(options, data))
     end
 
     def delete(uri, options = {})
-      options.merge!(:debug_output => @debug_output) if @debug
-      response = HTTParty.delete(@base_uri + uri, options)
-      raise HTTPException.new(response) if response.code >= 400
+      process_response HTTParty.delete(@base_uri + uri, process_options(options))
     end
 
     def users
       UserManager.new(self)
     end
 
+    private
+      def process_response(response)
+        raise HTTPException.new(response) if response.code >= 400
+        return response
+      end
+
+      def process_options(options, data=nil)
+        options = options.dup
+
+        if data
+          data = data.to_json unless options.delete(:raw_data)
+          options[:body] ||= data
+          options[:headers] = (options[:headers] || {}).dup
+          options[:headers]['Content-Type'] ||= 'application/json'
+        end
+
+        options[:debug_output] ||= @debug_output if @debug
+
+        return options
+      end
+
     class HTTPException < Exception
       def initialize(response)
         msg = "#{response.code} #{response.message}"

data/lib/grendel/document.rb

@@ -3,7 +3,7 @@ module Grendel
     attr_accessor :user, :name, :uri, :data, :content_type
 
     def initialize(user, params)
-      params.symbolize_keys!
+      params = Mash.new(params)
       @user = user
       @client = user.client
       @name = params[:name]

data/lib/grendel/link.rb

@@ -3,7 +3,7 @@ module Grendel
     attr_accessor :document, :user, :uri
 
     def initialize(document, user, params = {})
-      params.symbolize_keys!
+      params = Mash.new(params)
       @document = document
       @user = user
       @uri = params[:uri] ?

data/lib/grendel/linked_document.rb

@@ -12,7 +12,7 @@ module Grendel
     #   :uri => owner uri
     # }
     def initialize(linked_user, params)
-      params.symbolize_keys!
+      params = Mash.new(params)
       @owner = User.new(linked_user.client, params[:owner])
       super(@owner, params)
       @linked_user = linked_user

data/lib/grendel/mash.rb

@@ -0,0 +1,150 @@
+# borrowed from http://github.com/wycats/merb-extlib/raw/master/lib/merb-extlib/mash.rb
+# MIT-Licensed
+
+# This class has dubious semantics and we only have it so that people can write
+# params[:key] instead of params['key'].
+module Grendel
+  class Mash < Hash
+
+    # @param constructor<Object>
+    #   The default value for the mash. Defaults to an empty hash.
+    #
+    # @details [Alternatives]
+    #   If constructor is a Hash, a new mash will be created based on the keys of
+    #   the hash and no default value will be set.
+    def initialize(constructor = {})
+      if constructor.is_a?(Hash)
+        super()
+        update(constructor)
+      else
+        super(constructor)
+      end
+    end
+
+    # @param key<Object> The default value for the mash. Defaults to nil.
+    #
+    # @details [Alternatives]
+    #   If key is a Symbol and it is a key in the mash, then the default value will
+    #   be set to the value matching the key.
+    def default(key = nil)
+      if key.is_a?(Symbol) && include?(key = key.to_s)
+        self[key]
+      else
+        super
+      end
+    end
+
+    alias_method :regular_writer, :[]= unless method_defined?(:regular_writer)
+    alias_method :regular_update, :update unless method_defined?(:regular_update)
+
+    # @param key<Object> The key to set.
+    # @param value<Object>
+    #   The value to set the key to.
+    #
+    # @see Mash#convert_key
+    # @see Mash#convert_value
+    def []=(key, value)
+      regular_writer(convert_key(key), convert_value(value))
+    end
+
+    # @param other_hash<Hash>
+    #   A hash to update values in the mash with. The keys and the values will be
+    #   converted to Mash format.
+    #
+    # @return <Mash> The updated mash.
+    def update(other_hash)
+      other_hash.each_pair { |key, value| regular_writer(convert_key(key), convert_value(value)) }
+      self
+    end
+
+    alias_method :merge!, :update
+
+    # @param key<Object> The key to check for. This will be run through convert_key.
+    #
+    # @return <TrueClass, FalseClass> True if the key exists in the mash.
+    def key?(key)
+      super(convert_key(key))
+    end
+
+    # def include? def has_key? def member?
+    alias_method :include?, :key?
+    alias_method :has_key?, :key?
+    alias_method :member?, :key?
+
+    # @param key<Object> The key to fetch. This will be run through convert_key.
+    # @param *extras<Array> Default value.
+    #
+    # @return <Object> The value at key or the default value.
+    def fetch(key, *extras)
+      super(convert_key(key), *extras)
+    end
+
+    # @param *indices<Array>
+    #   The keys to retrieve values for. These will be run through +convert_key+.
+    #
+    # @return <Array> The values at each of the provided keys
+    def values_at(*indices)
+      indices.collect {|key| self[convert_key(key)]}
+    end
+
+    # @return <Mash> A duplicate of this mash.
+    def dup
+      Mash.new(self)
+    end
+
+    # @param hash<Hash> The hash to merge with the mash.
+    #
+    # @return <Mash> A new mash with the hash values merged in.
+    def merge(hash)
+      self.dup.update(hash)
+    end
+
+    # @param key<Object>
+    #   The key to delete from the mash.\
+    def delete(key)
+      super(convert_key(key))
+    end
+
+    # Used to provide the same interface as Hash.
+    #
+    # @return <Mash> This mash unchanged.
+    def stringify_keys!; self end
+
+    # @return <Hash> The mash as a Hash with string keys.
+    def to_hash
+      Hash.new(default).merge(self)
+    end
+
+    protected
+    # @param key<Object> The key to convert.
+    #
+    # @param <Object>
+    #   The converted key. If the key was a symbol, it will be converted to a
+    #   string.
+    #
+    # @api private
+    def convert_key(key)
+      key.kind_of?(Symbol) ? key.to_s : key
+    end
+
+    # @param value<Object> The value to convert.
+    #
+    # @return <Object>
+    #   The converted value. A Hash or an Array of hashes, will be converted to
+    #   their Mash equivalents.
+    #
+    # @api private
+    def convert_value(value)
+      case value
+      when Hash
+        converted = Mash.new(value)
+        converted.default = value.default
+        converted
+      when Array
+        value.collect { |e| convert_value(e) }
+      else
+        value
+      end
+    end
+  end
+end

data/lib/grendel/user.rb

@@ -9,7 +9,7 @@ module Grendel
     #  uri
     #  password
     def initialize(client, params)
-      params.symbolize_keys!
+      params = Mash.new(params)
       @client = client
       @id = params[:id]
       @uri = params[:uri] ?

data/spec/grendel/client_spec.rb

@@ -4,16 +4,16 @@ describe "Grendel::Client" do
   before do
     @client = Grendel::Client.new("http://example.com")
   end
-  
+
   describe "new method" do
     it "should set the base_uri" do
       @client.base_uri.should == "http://example.com"
     end
   end
-  
+
   describe "users method" do
     it "should return a Grendel::UserManager" do
-      @client.users.class.should be(Grendel::UserManager)
+      @client.users.should be_a(Grendel::UserManager)
     end
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Brad Greenlee
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-27 00:00:00 -07:00
+date: 2010-04-29 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -75,7 +75,6 @@ files:
 - TODO.md
 - VERSION
 - grendel-ruby.gemspec
-- lib/core_ext/hash.rb
 - lib/grendel.rb
 - lib/grendel/client.rb
 - lib/grendel/document.rb
@@ -84,6 +83,7 @@ files:
 - lib/grendel/link_manager.rb
 - lib/grendel/linked_document.rb
 - lib/grendel/linked_document_manager.rb
+- lib/grendel/mash.rb
 - lib/grendel/user.rb
 - lib/grendel/user_manager.rb
 - spec/grendel/client_spec.rb

data/lib/core_ext/hash.rb

@@ -1,17 +0,0 @@
-# stolen^H^H^H^H^H^Hborrowed from Rails' ActiveSupport
-class Hash
-  # Return a new hash with all keys converted to symbols, as long as
-  # they respond to +to_sym+.
-  def symbolize_keys
-    dup.symbolize_keys!
-  end
- 
-  # Destructively convert all keys to symbols, as long as they respond
-  # to +to_sym+.
-  def symbolize_keys!
-    keys.each do |key|
-      self[(key.to_sym rescue key) || key] = delete(key)
-    end
-    self
-  end
-end