danarchy_couchdb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c79285e5a743f8a96a416ee600eb7a9c2733b483
+  data.tar.gz: 16676412cf347a7e3ba82d7fe6967645b7e00739
+SHA512:
+  metadata.gz: e9700a452ee99b02a55024db976abcdfa84508561bd2eec2b0a92ff4d9cf7cba1bfc1c58984779c8455c72874830e0147d1e2b2f28dc1e2af16ff7c2e4ae622b
+  data.tar.gz: 325e00876a2c1a4a20ac68beb5a16d41d07245b01b033d2fe35bcb90042d8b6fbb5725e745230df265a0571ee0e7ca6beb3dfca2cc3b09e8dd74816b8c6130e8

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.9
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in danarchy_couchdb.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    danarchy_couchdb (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  danarchy_couchdb!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Dan Heneise
+
+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,86 @@
+# DanarchyCouchDB
+
+A Ruby implementation of CouchDB.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'danarchy_couchdb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install danarchy_couchdb
+
+## Usage
+
+A new DanarchyCouchDB object is created using a hash of connection values:
+
+With SSL:
+```ruby
+conn = { host: 'hostname/IPaddr', port: '6984', user: 'cdb_user', pass: 'cdb_passwd', use_ssl: true }
+```
+
+Without SSL:
+```ruby
+conn = { host: 'hostname/IPaddr', port: '5984', user: 'cdb_user', pass: 'cdb_passwd', use_ssl: false }
+```
+
+Create the object:
+```ruby
+cdb = DanarchyCouchDB::Connection.new(conn)
+```
+
+All calls to CouchDB comprise of at least a 'database' and 'document' argument, and PUT requires an additional hash, which it will turn into JSON formatting to send to CouchDB:
+
+```ruby
+# View all databases:
+cdb.get('_all_dbs', '')
+=> ["_replicator", "_users", "test_suite_db", "test_suite_db2"]
+
+database = 'test_suite_db'
+
+# View all documents within a database:
+cdb.get('test_suite_db', '_all_docs')
+=> {:total_rows=>3, :offset=>0, :rows=>[{:id=>"3853a22cbc4520c65f81c8689706009a", :key=>"3853a22cbc4520c65f81c8689706009a", :value=>{:rev=>"1-027467bd0efec85f21c822a8eb537073"}}, {:id=>"3853a22cbc4520c65f81c86897060c60", :key=>"3853a22cbc4520c65f81c86897060c60", :value=>{:rev=>"1-3975759ccff3842adf690a5c10caee42"}}, {:id=>"3853a22cbc4520c65f81c86897060dc0", :key=>"3853a22cbc4520c65f81c86897060dc0", :value=>{:rev=>"1-23202479633c2b380f79507a776743d5"}}]}
+
+# Load a document:
+test_suite_db = cdb.get('test_suite_db', '3853a22cbc4520c65f81c86897060c60')
+=> {:_id=>"3853a22cbc4520c65f81c86897060c60", :_rev=>"1-3975759ccff3842adf690a5c10caee42", :a=>2}
+
+# Add a new key=>value to the document:
+test_suite_db[:taxation] = 'is extortion'
+p test_suite_db
+=> {:_id=>"3853a22cbc4520c65f81c86897060c60", :_rev=>"1-3975759ccff3842adf690a5c10caee42", :a=>2, :taxation=>"is extortion"}
+
+# Update the document within CouchDB:
+cdb.put('test_suite_db', '3853a22cbc4520c65f81c86897060c60', test_suite_db)
+=> {:ok=>true, :id=>"3853a22cbc4520c65f81c86897060c60", :rev=>"2-743ac80b9a990d2644bc92bafb452fe5"}
+
+# We can verify the update with another cdb.get to update the hash to the latest document revision:
+test_suite_db = cdb.get('test_suite_db', '3853a22cbc4520c65f81c86897060c60')
+=> {:_id=>"3853a22cbc4520c65f81c86897060c60", :_rev=>"2-743ac80b9a990d2644bc92bafb452fe5", :a=>2, :taxation=>"is extortion"}
+
+# cdb.get can also take an optional revision argument:
+test_suite_db = cdb.get('test_suite_db', '3853a22cbc4520c65f81c86897060c60', '3-9de3ebabb6ea97fb4015cb698d228aec')
+=> {:_id=>"3853a22cbc4520c65f81c86897060c60", :_rev=>"3-9de3ebabb6ea97fb4015cb698d228aec", :a=>2, :taxation=>"is extortion"}
+
+# Delete a document with cdb.delete with a required revision:
+cdb.delete('test_suite_db', '3853a22cbc4520c65f81c86897060c60', '3-9de3ebabb6ea97fb4015cb698d228aec')
+=> {:ok=>true, :id=>"3853a22cbc4520c65f81c86897060c60", :rev=>"4-b35392a676cdbafebefaf425c6913670"}
+
+```
+
+## Contributing
+
+Bug reports are welcome on GitHub at https://github.com/danarchy85/danarchy_couchdb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "danarchy_couchdb"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/danarchy_couchdb.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "danarchy_couchdb/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "danarchy_couchdb"
+  spec.version       = DanarchyCouchDB::VERSION
+  spec.authors       = ["Dan James"]
+  spec.email         = ["dan@danarchy.me"]
+
+  spec.summary       = %q{dAnarchy CouchDB connector.}
+  spec.description   = %q{A CouchDB API connector for dAnarchy gems.}
+  spec.homepage      = "https://github.com/danarchy85/danarchy_couchdb"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/danarchy_couchdb/version.rb

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

data/lib/danarchy_couchdb.rb

@@ -0,0 +1,77 @@
+require_relative 'danarchy_couchdb/version'
+require 'json'
+require 'net/http'
+
+module DanarchyCouchDB
+  class Connection
+    def initialize(connection)
+      @connection = connection
+      uri = 'http' if !@connection[:use_ssl]
+      uri = 'https' if @connection[:use_ssl]
+      @uri = "#{uri}://#{connection[:host]}:#{connection[:port]}"
+    end
+
+    def get(*args)
+      database = args.shift
+      document = args.shift
+      revision = args.shift
+      
+      uri  = "#{@uri}/#{database}"
+      uri += "/#{document}"        if document
+      uri += "/?rev=#{revision}"   if revision
+
+      uri = URI.parse(URI.encode(uri))
+      request(Net::HTTP::Get.new(uri))
+    end
+
+    def put(*args)
+      database = args.shift
+      document = args.shift
+      data     = args.shift
+      
+      uri  = "#{@uri}/#{database}"
+      uri += "/#{document}" if document
+
+      uri = URI.parse(URI.encode("#{@uri}/#{database}/#{document}"))
+      req = Net::HTTP::Put.new(uri)
+      req["content-type"] = "application/json"
+      req.body = data.to_json if data
+      request(req)
+    end
+
+    def delete(*args)
+      database = args.shift
+      document = args.shift
+      revision = args.shift
+      
+      uri  = "#{@uri}/#{database}"
+      uri += "/#{document}"        if document
+      uri += "/?rev=#{revision}"   if revision
+
+      uri = URI.parse(URI.encode(uri))
+      request(Net::HTTP::Delete.new(uri))
+    end
+
+    private
+    def request(uri)
+      response = nil
+
+      Net::HTTP.start(@connection[:host], @connection[:port], :use_ssl => @connection[:use_ssl]) do |http|
+        uri.basic_auth @connection[:user], @connection[:pass]
+
+        response = http.request(uri)
+
+        unless response.kind_of?(Net::HTTPSuccess)
+          handle_error(uri, response)
+          break
+        end
+      end
+
+      JSON.parse(response.body, symbolize_names: true)
+    end
+
+    def handle_error(req, res)
+      puts RuntimeError.new("#{res.code}:#{res.message}\nMETHOD:#{req.method}\nURI:#{req.path}\n#{res.body}")
+    end
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: danarchy_couchdb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dan James
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A CouchDB API connector for dAnarchy gems.
+email:
+- dan@danarchy.me
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- danarchy_couchdb.gemspec
+- lib/danarchy_couchdb.rb
+- lib/danarchy_couchdb/version.rb
+homepage: https://github.com/danarchy85/danarchy_couchdb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.14
+signing_key: 
+specification_version: 4
+summary: dAnarchy CouchDB connector.
+test_files: []