json_hash 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e6eb3ab0716e36abec34ef40bc1af6752373773
+  data.tar.gz: 06d8d190c23d6c32034c2353e4ef2b283247e4e1
+SHA512:
+  metadata.gz: ec5cd1df497e0d1049f6c7035716c97c5fe3db7325e414669902e856ed4e0cb126b5ca4289ed2678d14ffd03a1101d1f539d91dfeda78f34a059507ea25dae3b
+  data.tar.gz: 9fe316a8c9918fb26c7c5b4239ba5138870b2577e525804c4e5bc8df19d5098e2fc0e4a8432e71d48e68b21890f279aa15d2bfd4294e25a8f37aa4074e1ff941

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Nathan Brazil
+
+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,47 @@
+# json_hash
+
+This is a simple gem that provides method-like syntatic sugar on top of a JSON object via the JSONHash class.
+
+## Installation
+
+If you are using Bundler, simply add the following line to your Gemfile:
+
+    gem "json_hash"
+
+Otherwise, just type:
+
+    gem install json_hash
+
+## Usage
+
+The canonical usage is to obtain some JSON text from a remote endpoint, and parse it.  For example:
+
+```ruby
+require "json_hash"
+ => true
+user = JSONHash.parse("http://example.org/users/1.json")
+ => #<JSONHash:0x007fe0d320fd30 @json={"id"=>1, ...}
+user.id
+ => 1 
+users = JSONHash.parse("http://cumulus.local/identity-manager/users.json")
+ => [#<JSONHash:0x007fe0d322c368 @json={"id"=>1, ...}, ...]
+users.count
+ => 4 
+users[1].id
+ => 2 
+```
+
+## Requirements
+
+The json_hash gem relies on the following:
+
+* The json gem
+* The open-uri module
+* The uri module
+
+## Credits
+
+This was inspired by a similar class I wrote in Python to parse Jenkin's RESTful API output, which made use of the
+setattr() method.  I wanted to see if I can do something similar in Ruby.
+
+Alas, since Ruby doesn't have something like setattr(), I've had to rely on method_missing() instead.

data/lib/json_hash.rb

@@ -0,0 +1,70 @@
+require "json"
+require "open-uri"
+require "uri"
+
+##
+# Provides syntactic sugar to a JSON structure.
+# Given a Ruby hash h, instead of using h[key] to obtain its value, you can use the
+# syntax of h.key, as if you are invoking a method.
+
+class JSONHash
+
+  ##
+  # Initializer.  The json parameter is a Ruby hash.  Usually you would call JSON.parse to get such a hash.
+  # @param json [Hash] A Ruby hash, usually obtained by calling JSON.parse or HTTP GET on a .json endpoint.
+
+  def initialize(json)
+    @json = json
+    @json.each do |key,value|
+      if value.class == Hash
+        @json[key] = JSONHash.new(value)
+      elsif value.class == Array
+        values = value.collect { |v| v.class == Hash ? JSONHash.new(v) : v }
+        @json[key] = values
+      end
+    end
+  end
+
+  ##
+  # Whatever .method is invoked, it will convert that to a string and use it as the key to look it up in the hash.
+  # @param method [String, Symbol] The name of method to invoke.
+  # @param args The arguments supplied to the method.
+
+  def method_missing(method, *args)
+    @json[method.to_s] || super
+  end
+
+  ##
+  # Returns the underling JSON parsed hash structure.
+  # @return [JSON] Underlying JSON object.
+
+  def to_json
+    @json
+  end
+
+  ##
+  # Return a string representation of the JSON parsed hash structure.
+  # @return [String] String representation of the underlying JSON object.
+
+  def to_s
+    @json.to_s
+  end
+
+  ##
+  # Build an array of JSONHash objects if the argument is an array of Hash instances.  If the argument is an URI,
+  # then parse the URI contents with JSON.parse, and then build it.  If the argument is a string, then parse it
+  # using JSON.parse first, then try to parse it again.  Otherwise, assume it's a single Hash object and build
+  # just a single JSONHash object.
+  # @param from [Array, Hash, String, URI] Object to build from.
+  # @return [Array, JSONHash] Either an array of JSONHash objects or a single JSONHash object.
+
+  def self.parse(from)
+    return JSONHash.new(from) if from.class == Hash
+    return from.collect { |item| parse(item) } if from.class == Array
+    return parse(JSON.parse(open(from) { |fp| fp.read })) if from.is_a? URI::Generic
+    # Assume from is String from here on
+    return parse(URI.parse(from)) if /^http[s]?:\/\/.+/ =~ from
+    return parse(JSON.parse(from))
+  end
+
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: json_hash
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Nathan Brazil
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+description: A simple gem that adds method-like syntactic sugar to a JSON hash.
+email: nb@bitaxis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/json_hash.rb
+homepage: https://github.com/bitaxis/json_hash.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Hola!
+test_files: []
+has_rdoc: