rjp 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd9e758193d81f3ab944e5c5fd1383abbde2593d
+  data.tar.gz: ea16b330c441602ba7a12179d939d7d886aa8f21
+SHA512:
+  metadata.gz: ed763647f9121b8a88948067da2493f35cb4658b2dda8942a5fa33903ac199b9e3521ab6b935a3f6044b68d2df4ead2a0ba106aaf7c6a040d3f8bd963811e65c
+  data.tar.gz: 2862f39b469226df41bfb5663e3340a8f8ddae24d9674429567e4204dd2e132fc6f305038e053b650d69312c75566f29a259cf81ac96f9fa488a11ee9967bd8c

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tags

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tyler Dooling
+
+MIT License
+
+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,66 @@
+# rjp
+
+A command line tool for formatting JSON and extracting values.
+
+## Installation
+
+    $ gem install rjp
+
+## Usage
+
+### Formating a JSON response
+```bash
+$ curl https://api.github.com | rjp
+{
+                 "current_user_url" => "https://api.github.com/user",
+               "authorizations_url" => "https://api.github.com/authorizations",
+                  "code_search_url" => "https://api.github.com/search/code?q={query}{&page,per_page,sort,order}",
+                       "emails_url" => "https://api.github.com/user/emails",
+                       "emojis_url" => "https://api.github.com/emojis",
+                       "vents_url" => "https://api.github.com/events",
+                        "feeds_url" => "https://api.github.com/feeds",
+                    "following_url" => "https://api.github.com/user/following{/target}",
+                        "gists_url" => "https://api.github.com/gists{/gist_id}",
+                          "hub_url" => "https://api.github.com/hub",
+                 "issue_search_url" => "https://api.github.com/search/issues?q={query}{&page,per_page,sort,order}",
+                       "issues_url" => "https://api.github.com/issues",
+                         "keys_url" => "https://api.github.com/user/keys",
+                "notifications_url" => "https://api.github.com/notifications",
+    "organization_repositories_url" => "https://api.github.com/orgs/{org}/repos/{?type,page,per_page,sort}",
+                 "organization_url" => "https://api.github.com/orgs/{org}",
+                 "public_gists_url" => "https://api.github.com/gists/public",
+                   "rate_limit_url" => "https://api.github.com/rate_limit",
+                   "repository_url" => "https://api.github.com/repos/{owner}/{repo}",
+            "repository_search_url" => "https://api.github.com/search/repositories?q={query}{&page,per_page,sort,order}",
+    "current_user_repositories_url" => "https://api.github.com/user/repos{?type,page,per_page,sort}",
+                      "starred_url" => "https://api.github.com/user/starred{/owner}{/repo}",
+                "starred_gists_url" => "https://api.github.com/gists/starred",
+                         "team_url" => "https://api.github.com/teams",
+                         "user_url" => "https://api.github.com/users/{user}",
+           "user_organizations_url" => "https://api.github.com/user/orgs",
+            "user_repositories_url" => "https://api.github.com/users/{user}/repos{?type,page,per_page,sort}",
+                  "user_search_url" => "https://api.github.com/search/users?q={query}{&page,per_page,sort,order}"
+}
+```
+### Chaining to navigate hypermedia apis
+```bash
+$ curl https://api.github.com | rjp -k current_user_url | xargs curl -u {github_auth} | rjp
+```
+### Default value
+```bash
+$ curl https://api.github.com | rjp -k not_present -d default_value
+"default_value"
+```
+### Post processing
+```bash
+$ curl https://api.github.com | rjp -k current_user_url -e 'value.upscase'
+"HTTPS://API.GITHUB.COM/USER"
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/bin/rjp

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'ostruct'
+require 'ap'
+require 'rjp'
+
+opts = OpenStruct.new(
+  keys: [],
+  default_value: nil,
+  post_processor: ->(value){ value }
+)
+option_parser = OptionParser.new do |options|
+  options.set_banner "Usage: rjp [options] [key/s] [file]\n" \
+    "Parse json to a ruby hash for data access."
+
+  options.separator ""
+  options.separator "Specific options:"
+
+  options.on("-k", "--keys x,y,z", Array, "Keys to fetch from document") do |keys|
+    opts.keys = keys
+  end
+
+  options.on("-d", "--default key", "Default value if key is missing.") do |default|
+    opts.default_value = default
+  end
+
+  options.on("-e", "--eval expression", "Code to evaluate using value or document.") do |code|
+    opts.post_processor = eval "->(value){ #{code} }"
+  end
+
+  options.on_tail("-h", "--help", "You're looking at it!") do
+    $stderr.puts options
+    exit 1
+  end
+end
+option_parser.parse!
+
+input = ARGF.read
+parser = Rjp.new input
+
+output = if !opts.keys.empty?
+           if opts.default_value.nil?
+             parser.extract(*opts.keys)
+           else
+             parser.extract(*opts.keys) { opts.default_value }
+           end
+         else
+           parser.to_h
+         end
+ap opts.post_processor.call(output)

data/lib/rjp.rb

@@ -0,0 +1,27 @@
+require "rjp/version"
+require 'rjp/traversable'
+require 'json'
+
+module Rjp
+  def self.new(*args)
+    Parser.new(*args)
+  end
+
+  class Parser
+    def initialize(json_str)
+      @raw = json_str
+    end
+
+    def extract(*keys, &block)
+      json.traverse(*keys, &block)
+    end
+
+    def to_h
+      json
+    end
+
+    def json
+      @json ||= Traversable.new(JSON.parse @raw)
+    end
+  end
+end

data/lib/rjp/traversable.rb

@@ -0,0 +1,14 @@
+require 'delegate'
+
+class Traversable < SimpleDelegator
+  def traverse(*args, &block)
+    args.inject(self) { |obj, arg|
+      arg = Float(arg).to_i if obj.kind_of? Array
+      obj.fetch(arg, &block)
+    }
+  end
+
+  def class
+    __getobj__.class
+  end
+end

data/lib/rjp/version.rb

@@ -0,0 +1,3 @@
+module Rjp
+  VERSION = "0.0.1"
+end

data/rjp.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rjp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rjp"
+  spec.version       = Rjp::VERSION
+  spec.authors       = ["Tyler Dooling"]
+  spec.email         = ["me@tylerdooling.com"]
+  spec.description   = %q{A command line tool for formatting JSON and extracting values}
+  spec.summary       = %q{A command line tool for formatting JSON and extracting values}
+  spec.homepage      = "https://github.com/tylerdooling/rjp"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_dependency "awesome_print"
+end

data/spec/lib/rjp/rjp_spec.rb

@@ -0,0 +1,28 @@
+require 'rspec'
+require 'rjp'
+
+describe Rjp do
+  let(:json_string) { %({ "level1": #{level1}}) }
+  let(:level1) { %({ "level2" : #{level2} }) }
+  let(:level2) { '[ { "level3a": "level3a_value" }, { "level3b": "level3b_value" } ]' }
+  let(:rjp) { Rjp.new json_string }
+
+  it "parses json to a hash" do
+    expect(rjp.to_h).to eq(JSON.parse json_string)
+  end
+
+  describe '#extract' do
+    it "returns a value for a key" do
+      expect(rjp.extract('level1')).to eq(JSON.parse level1)
+    end
+
+    it "returns a value for an index" do
+      rjp = Rjp.new '[ "zero", "one"]'
+      expect(rjp.extract(0)).to eq('zero')
+    end
+
+    it "returns a value for a list of nested keys or indecies" do
+      expect(rjp.extract('level1', 'level2', 0, 'level3a')).to eq('level3a_value')
+    end
+  end
+end

data/spec/rjp_spec.rb

@@ -0,0 +1,58 @@
+require 'rspec'
+require 'rjp'
+
+describe 'rjp' do
+  let(:json_string) { %({"level1": #{level1}}) }
+  let(:level1) { %({ "level2" : #{level2} }) }
+  let(:level2) { %([ { "level3a": "level3a_value" }, { "level3b": "level3b_value" } ]) }
+  let(:rjp) { File.expand_path(File.join('..', '..', 'bin', 'rjp'), __FILE__) }
+
+  it "accepts stdin" do
+    expect(`echo '{ "key": "value" }' | #{rjp} -k key`).to eq(%("value"\n))
+  end
+
+  it "accepts file list" do
+    `echo '{ "key": "value" }' > /tmp/rjp_json_test`
+    expect(`#{rjp} -k key /tmp/rjp_json_test`).to eq(%("value"\n))
+    `rm /tmp/rjp_json_test`
+  end
+
+  it "outputs formated a hash to stdout" do
+    str=<<-hash
+{
+    "level1" => {
+        "level2" => [
+            [0] {
+                "level3a" => "level3a_value"
+            },
+            [1] {
+                "level3b" => "level3b_value"
+            }
+        ]
+    }
+}
+    hash
+    expect(`echo '#{json_string}' | #{rjp}`).to eq(str)
+  end
+
+  context "when --keys are provided" do
+    it "extracts the value from the hash" do
+      expect(`echo '#{json_string}' | #{rjp} -k level1,level2,0,level3a`).to eq(%("level3a_value"\n))
+      expect(`echo '#{json_string}' | #{rjp} --keys level1,level2,0,level3a`).to eq(%("level3a_value"\n))
+    end
+
+    context "when the key is not found" do
+      it "returns a non-zero status" do
+        `echo '#{json_string}' | #{rjp} -k level1,level2,something`
+        expect($?.exitstatus).to eq(1)
+      end
+
+      context "when --default is provided" do
+        it "it is returned" do
+          expect(`echo '#{json_string}' | #{rjp} -k something -d default`).to eq(%("default"\n))
+          expect(`echo '#{json_string}' | #{rjp} --keys something --default default`).to eq(%("default"\n))
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: rjp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tyler Dooling
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A command line tool for formatting JSON and extracting values
+email:
+- me@tylerdooling.com
+executables:
+- rjp
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/rjp
+- lib/rjp.rb
+- lib/rjp/traversable.rb
+- lib/rjp/version.rb
+- rjp.gemspec
+- spec/lib/rjp/rjp_spec.rb
+- spec/rjp_spec.rb
+homepage: https://github.com/tylerdooling/rjp
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A command line tool for formatting JSON and extracting values
+test_files:
+- spec/lib/rjp/rjp_spec.rb
+- spec/rjp_spec.rb