super_uri 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7abba009347a073727d723c8b4c4fc5cc29f93d9
-  data.tar.gz: 06ee087ee08947263c4543db2a3c38383dc31616
+  metadata.gz: d224d64c8343f47d13dab91f055e08b7c0031891
+  data.tar.gz: 8fa8bbf2a43852a6f5ad68acab65214de21ae3c1
 SHA512:
-  metadata.gz: 8aee6eda0c5db337446458650a5d486e55d0cb81a03310cac2b88ac2afbdb1dd0c98c07d3fccc539da949fd9bc5d92a55d4a3d337581489f8a353c07c44ed9cb
-  data.tar.gz: 614c41d44facbe3b637c4b129e9598ccb35ea0b9a82400817acbbf44238109cb04ef6aafdada7d2ef421d77d200e10763309168fbf01bf2234bba8870eceb65d
+  metadata.gz: 30c29b7d019199916d37cc65a9e560562b8a1934f3a7caef6316d15c8691d430bf086e66ac97227b38582989bb671bb61eaadeca534acba70b10d6f8619e9b60
+  data.tar.gz: f66ef6f105ba27238ae76e405e7894d932f27314af0f2d0aa86acdda501c47cd62f1e368c967f1f15bef6aa411c74fce26dd4350316420176ae96eb1d5965ddf

data/.travis.yml

@@ -1,5 +1,15 @@
-sudo: false
-language: ruby
+addons:
+  code_climate:
+    secure: VkxvWVpNOS80dyiX+qpoFikyapclc9puDKeWr1UkCDAJG1MVKGPw1LfB2Yr6YIKR1AL7c7tzobSNEFYBgUsa+rM0ktd7Vq1yBdFdfIeU+Hle8Eys24P3shZFQqc5ejUvGT0PpgDZv7XkjYPwPvnlAGuV+6JjkcjWVq670U5fmHKjKbaU1NYLoBNBimtkyMZSesnr5hklMK6GUTimqYs+81UHYMlbfsN6Bvjs3v8UCNlEfcjYUCgzlujhXbCqNmnCtNMJD26+Z/fYcCUZ0IHRgEN19gWz2UimRZrznBXL2/kfDWIsBYLOXr89yf6fiP9k7A1NWNTyzlKNvkijmgd9k+N1wcCBdO1c7FcnQZqORtQz8k8orLiqfCrLoNWboWhWdV6XY8+0+u3ioK0mtkk/NGssy6ssdEoqSWwrgZGqqz4uE8YMvtuo/KNdNijnyAPRdJUbOY7fWgn78Qr/fmtNG5YJU3XxILjvU6IGvRLZq65Au6dL4WyiyKgI9soP+KctxuMYTaJKSMYdUSdB+af6IOFER0tZSpjZXIJO9DWfJhfUxCBoDJlYsGQj3XRO+Zku0DfUTEHUKPjj3JZNpi8X+1rqwPnLadnmlZigplA+rXZ7qKESVJ3zvsW8/HLF0IEXkC7OH2uXrv/f+Pzc8A2ZKtxRxbjMZF9SjaimnP2jja8=
+cache: bundler
 rvm:
-  - 2.4.0
-before_install: gem install bundler -v 1.13.7
+- 2.3.3
+- 2.4.0
+services: 
+before_script: 
+script: bundle exec rspec
+after_success:
+- bundle exec codeclimate-test-reporter
+env:
+  secure: ZU8MnRwkMkpRhXoXd0bCVepNfK0FFzLdvekDJWguJJVHQwqGSjl6v4hp72nQrs4NcIPz+16UlRSEBzGvmYCQVimoGp4HqcunvAjJdzpSXCbdXzM+A5NYhslj0dUnfvjdKfszsuTmezZm2c7+c53boK2fvvxur9qVa0RrWRp11vMmevRB0K9VA/FZPRO94uZXQvFUQ5ZsSvx0fmCinwDFrBF/erPmOkkxZv87NoR0RykmpCv53/P8N+xBSVhspU7gYie7oekRIDUBVxXK+j1VNl8lChUoofTBMgh7A5cfVQ5NQEFDCl9LLfeBZMOrS/dvancmbG16oPxFzyd161Bw7xehFP76qTOX3eQAhWv8FL+GkM381q43ctoZQNcRh8AV0oM7ra5GWyPFz5A4yYSu2gpuUFxlmtxYRM8eRKIYUb7n3efK/ZYr0Zd0ZrS8ZYfeRIO8bb1izn6UcWnhXjnBrNOsrKKTe7t6DzMFIwRMSXBUl2k7R8n5TTKkkvbQrNmE/OB6dYdGJbOZ8Hdjy+hdhNMg7Jmph+wmK8wi+Buv5tU8uNVgULB6QQUWIO3WRG+ekBFySGv+HdFSnuHPbEWmYevg+guskmYzCxgA8xLkR6xHyBq5QUt1v9wFPWldwmjbrVRsUnGjlW2zNHwp+u9u/1gRO6N69/6xg4vNyzSuBdg=
+notifications: 

data/README.md

@@ -1,8 +1,143 @@
-# SuperUri
+[![Downloads](http://ruby-gem-downloads-badge.herokuapp.com/super_uri?type=total)](https://rubygems.org/gems/super_uri)
+[![Gem Version](https://badge.fury.io/rb/super_uri.svg)](https://badge.fury.io/rb/super_uri)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/super_uri`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Build Status](https://travis-ci.org/kigster/super_uri.svg?branch=master)](https://travis-ci.org/kigster/super_uri)
+[![Code Climate](https://codeclimate.com/repos/588d08ab8dcb7c006a004c31/badges/fbe3044e50dfc06f7b93/gpa.svg)](https://codeclimate.com/repos/588d08ab8dcb7c006a004c31/feed)
+[![Test Coverage](https://codeclimate.com/repos/588d08ab8dcb7c006a004c31/badges/fbe3044e50dfc06f7b93/coverage.svg)](https://codeclimate.com/repos/588d08ab8dcb7c006a004c31/coverage)
+[![Issue Count](https://codeclimate.com/repos/588d08ab8dcb7c006a004c31/badges/fbe3044e50dfc06f7b93/issue_count.svg)](https://codeclimate.com/repos/588d08ab8dcb7c006a004c31/feed)
 
-TODO: Delete this and the text above, and describe your gem
+> **WARNING**: This gem is currently under active development, and is not yet stable. Use at your own risk.
+
+# SuperURI — Uniformly Locate Data Anywhere :) 
+
+## Summary
+
+This gem aims to combine the extensibility of the `URI` class — its design supports adding new and custom URI __schemes__, with the `open` and `read` semantics of the `OpenURI` standard ruby module, and aims to greatly expand the list of URIs that can be read. 
+
+Eventually this gem might also offer ability to **write** data to the URI.
+
+## Usage
+
+As much as possible, we wanted to extend the existing `OpenURI` interface:
+
+```ruby
+require 'super_uri'
+
+contents = URI([String]).read
+
+URI.parse([String]).open do |file|
+  #...
+end
+```
+
+### Additional Schemes
+ 
+The key to this gem is the large selection of the URIs that can be provided and instantly used to read data. Let's take a look at a few examples:
+
+```ruby
+require 'super_uri'
+
+URI('env://HOME').read
+# => "/Users/"
+
+URI('file:///usr/local/etc/hosts').read
+# => "127.0.0.1    localhost\n...."
+
+URI('redis:///1/mykey').read
+# => "keyvalue"
+
+```
+
+Future versions might allow writing and deleting of the data:
+
+```ruby
+# 
+URI('file:///usr/local/etc/hosts').write(data)
+# => 23425
+URI('file:///usr/local/etc/hosts').delete
+# => true
+
+URI('redis:///1/mykey').write('keyvalue')
+# => 8
+URI('redis:///1/mykey').delet
+# => true
+```
+
+
+### Motivation
+
+This gem was born out of the desire to easily read and write data via a large number of ways during development of another gem — [sym](https://github.com/kigster/sym) — which performs symmetric encryption, and needs to read the private key and the data, and write the result (and sometimes the private key). After running out of flags to pass indiciating how exactly the private key is supplied, I had an epiphany — what if I can just use one flag with the data source URI? 
+
+### Approach
+
+There are two high-level steps required to create a unified way of reading/writing various resources:
+
+ 1. One must define the syntax for describing how to access it
+ 2. One must implement the actual read/write code for each supported syntax.
+
+The most natural fit for 1 seems to be the `URI` module. It can be easily extended by design, and already supports many schemes out the box. In addition, a popular `OpenURI` extension adds the `open` call to `http[s]`, `ftp`, and `ssh` protocols, partially providing #2 for these schemes.
+
+However, `OpenURI` only supports a few protocols, and does not currently support *delete* operation. 
+
+The approach we take is to extend `URI` with the schemes with support, and fulfill them using `Handlers` that can be easily added.
+
+## Supported URIs
+
+The following types are planned to be supported:
+
+##### Environment Variables
+
+```ruby
+URI('env://HOME').read
+# => /Users/kig
+```
+##### Redis
+
+###### Read/Write Hash Value by Key
+
+```ruby
+URI::IO['redis://localhost:6379/1/firstname').write('konstantin')
+# => 'OK'
+URI::IO['redis://localhost:6379/1/firstname').read
+# => 'konstantin'
+```
+
+###### Any Operation?
+
+```ruby
+URI::IO['redis://localhost:6379/1/operation').run(*args)
+```
+
+##### File Operation
+
+```ruby
+URI::IO['scp://user@host/path/file').delete
+```
+
+Suggested possible ways of accessing local and remote data:
+
+```ruby
+URI('string://value').read
+# => "value"
+
+URI::IO['env://PATH').read
+# => "/bin:/usr/bin:/usr/local/bin"
+
+URI('stdin:/').read
+# => data from STDIN until EOF
+
+URI('shell://echo%20hello').read
+# => "hello"
+
+URI('redis://127.0.0.1:6397/1/get,firstname').read
+# => 'konstantin'
+```
+
+Similarly, we could read data from:
+
+    memcached://127.0.0.1:11211/operation,arg1,arg2,...
+    scp://user@host/path/file        
+    postgresql://user@host/db/?sql=<sql-query>
 
 ## Installation
 
@@ -20,9 +155,6 @@ Or install it yourself as:
 
     $ gem install super_uri
 
-## Usage
-
-TODO: Write usage instructions here
 
 ## Development
 
@@ -32,7 +164,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/super_uri.
+Bug reports and pull requests are welcome on GitHub at https://github.com/kigster/super_uri.
 
 
 ## License

data/lib/super_uri.rb

@@ -1,5 +1,10 @@
-require "super_uri/version"
+require 'uri'
 
-module SuperUri
-  # Your code goes here...
-end
+require 'super_uri/version'
+
+require 'super_uri/class/ext'
+require 'super_uri/hash/case_insensitive_symbolized_hash'
+require 'uri-ext'
+
+require 'uri/scp'
+require 'uri/file'

data/lib/super_uri/class/ext.rb

@@ -0,0 +1,7 @@
+class Class
+  # For a class name, eg. MyApp::Module::MyClass it attempts to extract a scheme
+  # such as 'MYCLASS'.
+  def uri_scheme
+    name.gsub(/.*::(\w+)$/, '\1').upcase
+  end
+end

data/lib/super_uri/hash/case_insensitive_symbolized_hash.rb

@@ -0,0 +1,15 @@
+
+class CaseInsensitiveSymbolizedHash < Hash
+  def [](key)
+    super(normalize(key))
+  end
+
+  def []=(key, value)
+    super(normalize(key), value)
+  end
+
+  private
+  def normalize(key)
+    key.to_s.downcase.to_sym
+  end
+end

data/lib/super_uri/version.rb

@@ -1,3 +1,3 @@
-module SuperUri
-  VERSION = "0.1.0"
+module SuperURI
+  VERSION = '0.1.1'
 end

data/lib/uri-ext.rb

@@ -0,0 +1,9 @@
+require 'uri'
+
+module URI
+  # Helper method to hide the hedious @@schemes.
+  def self.<<(klass, verb = klass.uri_scheme)
+    self.class_variable_set(:@@schemes, {}) unless self.class_variable_get(:@@schemes)
+    self.class_variable_get(:@@schemes)[verb.to_s.upcase] = klass
+  end
+end

data/lib/uri/file.rb

@@ -0,0 +1,22 @@
+require 'uri'
+require 'super_uri'
+require 'forwardable'
+
+module URI
+  class FILE < Generic
+
+    extend Forwardable
+    def_delegators :@path, :basename, :dirname
+
+    def buffer_open(buf, proxy, open_options)
+      buf << File.read(path)
+      buf.io.rewind
+    end
+
+    include OpenURI::OpenRead
+  end
+
+  self << FILE
+end
+
+

data/lib/uri/scp.rb

@@ -0,0 +1,2 @@
+require 'uri/scp'
+require 'uri/open-scp'

data/super_uri.gemspec

@@ -5,12 +5,12 @@ require 'super_uri/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "super_uri"
-  spec.version       = SuperUri::VERSION
+  spec.version       = SuperURI::VERSION
   spec.authors       = ["Konstantin Gredeskoul"]
   spec.email         = ["kigster@gmail.com"]
 
-  spec.summary       = %q{Placeholder: Gem to read/write to URIs}
-  spec.description   = %q{Placeholder: Gem to read/write to URIs}
+  spec.summary       = %q{Extension to the OpenURI module that understands many additional types of URI resources, and is able to open and read them. Included are: file://, scp://, env://, osxkeychain://, redis://, memcached:// schemes.}
+  spec.description   = %q{Extension to the OpenURI module that understands many additional types of URI resources, and is able to open and read them. Included are: file://, scp://, env://, osxkeychain://, redis://, memcached:// schemes.}
   spec.homepage      = "https://github.com/kigster/super_uri"
   spec.license       = "MIT"
 
@@ -21,7 +21,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency 'net-scp'
+
+  spec.add_development_dependency 'bundler', '~> 1'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'awesome_print'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'codeclimate-test-reporter',"~> 1.0.0"
+  spec.add_development_dependency 'rspec', '~> 3'
+
 end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: super_uri
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Konstantin Gredeskoul
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-27 00:00:00.000000000 Z
+date: 2017-02-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-scp
+  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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,21 +52,79 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-description: 'Placeholder: Gem to read/write to URIs'
+        version: '3'
+description: 'Extension to the OpenURI module that understands many additional types
+  of URI resources, and is able to open and read them. Included are: file://, scp://,
+  env://, osxkeychain://, redis://, memcached:// schemes.'
 email:
 - kigster@gmail.com
 executables: []
@@ -69,7 +141,12 @@ files:
 - bin/console
 - bin/setup
 - lib/super_uri.rb
+- lib/super_uri/class/ext.rb
+- lib/super_uri/hash/case_insensitive_symbolized_hash.rb
 - lib/super_uri/version.rb
+- lib/uri-ext.rb
+- lib/uri/file.rb
+- lib/uri/scp.rb
 - super_uri.gemspec
 homepage: https://github.com/kigster/super_uri
 licenses:
@@ -94,5 +171,7 @@ rubyforge_project:
 rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: 'Placeholder: Gem to read/write to URIs'
+summary: 'Extension to the OpenURI module that understands many additional types of
+  URI resources, and is able to open and read them. Included are: file://, scp://,
+  env://, osxkeychain://, redis://, memcached:// schemes.'
 test_files: []