couch_rest_adapter 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cfc5403241fb1a9255dc2bdffdfcd28adf3254b7
+  data.tar.gz: b93f5a093db645f00650b43e7c5d68143b76dd80
+SHA512:
+  metadata.gz: f7a72c34f1da276865262864334105cca4007123307028ac075cb1ccee0b81743e2ccb2762c6f6cd3ec551e2681e29df048d08aaa0319558339af67059ab78c2
+  data.tar.gz: 10538a8ba87daedc23cb76ca7299d58cf870e2a35d734d65d624c569584bc8f60507a66b808e62de373ffc706fbfd8553932e44f86df8e4f7deab5d5666bddaf

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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.rdoc

@@ -0,0 +1,28 @@
+= CouchRestAdapter
+
+This project rocks and uses MIT-LICENSE.
+
+== Requirements
+
+* Rails > 4
+* Couchrest
+* Requires config/database.yml file
+
+
+== Instalation
+
+=== In Gemfile
+
+    gem 'couch_rest_adapter', git: 'https://github.com:amco/couch_rest_adapter.git'
+
+=== Model Declaration
+
+
+  class User < CouchRestAdpater::Base
+    use_default_database
+  end
+  
+=== TODO
+
+* Allow setting new attributes with ```model.attribute = value```
+* More test coverage

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CouchRestAdapter'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/couch_rest_adapter/attribute_method.rb

@@ -0,0 +1,37 @@
+module CouchRestAdapter
+  module AttributeMethod
+
+    def read_write method, value = nil
+      writer?(method) ? write_value(method, value) : read_value(method)
+    end
+
+    def read_value method_name
+      singleton_class.class_eval do
+        define_method(method_name) { self[method_name] }
+      end
+      send(method_name)
+    end
+
+    def write_value method_name, value
+      base_method_name = method_without_equals(method_name)
+      singleton_class.class_eval do
+        define_method(method_name){ |v| self[base_method_name] = v }
+      end
+      send(method_name, value)
+    end
+
+    def method_without_equals method_name
+      method_name.to_s.sub(/=$/,'').to_sym
+    end
+
+    def writer? method_name
+      method_name =~ /=$/
+    end
+
+    def attribute_methods
+      _attributes.keys.map{ |attr| [attr, "#{attr}="] }.flatten
+    end
+
+  end
+end
+

data/lib/couch_rest_adapter/db_config.rb

@@ -0,0 +1,29 @@
+module CouchRestAdapter
+  module DbConfig
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      attr_accessor :config_file
+
+      def parse_config
+        YAML::load File.open config_file
+      end
+
+      def base_path
+        parts = parse_config[Rails.env]
+        "#{parts['protocol']}://#{parts['host']}:#{parts['port']}"
+      end
+
+      def full_path
+        "#{base_path}/#{parse_config[Rails.env]['name']}"
+      end
+
+      def config_file
+        root = Rails.env == 'test' ? File.expand_path("../../../test/dummy/",  __FILE__) : Rails.root
+        File.join(root, 'config', 'database.yml')
+      end
+    end
+  end
+end

data/lib/couch_rest_adapter/document_management.rb

@@ -0,0 +1,21 @@
+module CouchRestAdapter
+  module DocumentManagement
+    UUID_DOC = '_uuids/?'
+
+    def next_id
+      File.join self.class.model_name, uuids.first
+    end
+
+    def uuids opts = {}
+      uuid_doc = File.join UUID_DOC, query(opts)
+      uuids_path = File.join CouchRestAdapter::Base.base_path, uuid_doc
+      CouchRest.get( uuids_path )["uuids"]
+    end
+
+    def query opts = {}
+      CGI.unescape(opts.to_query)
+    end
+
+  end
+end
+

data/lib/couch_rest_adapter/helpers.rb

@@ -0,0 +1,11 @@
+module CouchRestAdapter
+  module Helpers
+    refine String do
+      def namespace_me name
+        return self if self.empty?
+        (self =~ /^#{name}\/.*/i) ? self : File.join(name, self)
+      end
+    end
+  end
+end
+

data/lib/couch_rest_adapter/query_views.rb

@@ -0,0 +1,29 @@
+require 'couch_rest_adapter/helpers'
+
+using CouchRestAdapter::Helpers
+
+module CouchRestAdapter
+  module QueryViews
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      #TODO: We can get this from Rails.application.class.name
+      DEFAULT_DESIGN = 'amcoid'
+
+      def query_view name
+        doc = name.namespace_me DEFAULT_DESIGN
+        view(doc, {key: model_name})['rows'].map{ |res| new res['doc'] }
+      end
+
+      #TODO: method for reduce, and filters
+      def view doc, attrs, reduce = false
+        database.view(doc, {reduce: reduce, include_docs: true}.merge!(attrs) )
+      end
+    end
+
+  end
+end
+

data/lib/couch_rest_adapter/railtie.rb

@@ -0,0 +1,9 @@
+module CouchRestAdapter
+  class Railtie < Rails::Railtie
+    initializer "Include your code in the controller" do
+      ActiveSupport.on_load(:action_controller) do
+        include CouchRestAdapter
+      end
+    end
+  end
+end

data/lib/couch_rest_adapter/version.rb

@@ -0,0 +1,3 @@
+module CouchRestAdapter
+  VERSION = "0.1.1"
+end

data/lib/couch_rest_adapter.rb

@@ -0,0 +1,68 @@
+require 'couchrest'
+require 'couch_rest_adapter/attribute_method'
+require 'couch_rest_adapter/query_views'
+require 'couch_rest_adapter/document_management'
+require 'couch_rest_adapter/db_config'
+
+require File.join(File.dirname(__FILE__), '/exceptions/couch_rest_adapter')
+
+using CouchRestAdapter::Helpers
+
+module CouchRestAdapter
+  class Base < CouchRest::Document
+    include ActiveSupport::Callbacks
+    include AttributeMethod
+    include QueryViews
+    include DocumentManagement
+    include DbConfig
+
+    #TODO: add custom callback calls.
+    define_callbacks :before_save
+
+    def initialize attrs = nil
+      raise NotImplementedError if abstract?
+      super attrs
+    end
+
+    def self.all
+      query_view('all')
+    end
+
+    def self.all_by_type
+      query_view('by_type')
+    end
+
+    def self.find doc_id
+      new database.get( doc_id.namespace_me(model_name) ).to_hash
+    end
+
+    def self.use_default_database
+      use_database CouchRest.database(full_path)
+    end
+
+    def save
+      run_callbacks :before_save do
+        self['_id'] = next_id if self['_id'].blank?
+        super
+      end
+    end
+
+    def method_missing method, *args, &block
+      if attribute_methods.include? method.to_s
+        read_write method, args.first
+      else
+        super
+      end
+    end
+
+    protected
+      def abstract?
+        self.class.to_s == 'CouchRestAdapter::Base'
+      end
+
+      def self.model_name
+        name.underscore
+      end
+
+  end
+end

data/lib/exceptions/couch_rest_adapter.rb

@@ -0,0 +1,8 @@
+module CouchRestAdapter
+  class NotImplementedError < RuntimeError
+    def to_s
+      "An abstract class can not be instantiated."
+    end
+  end
+end
+

data/lib/tasks/couch_rest_adapter_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :couch_rest_adapter do
+#   # Task goes here
+# end

data/test/couch_rest_adapter_test.rb

@@ -0,0 +1,100 @@
+require 'test_helper'
+
+class FooBar < CouchRestAdapter::Base
+  use_default_database
+end
+
+class CouchRestAdapterTest < ActiveSupport::TestCase
+
+  def setup
+    resp = {ok: true, id: "foo_bar/1", rev: "FF0000"}
+    FakeWeb.register_uri :put, %r|http://.*:5984/test/.*|, body: resp.to_json
+
+    get_resp = {_id: 'foo_bar/1', _rev: 'FF0000', foo: 'Foo', bar: 'Bar'}
+
+    FakeWeb.register_uri :get, %r|http://.*:5984/test/foo_bar.*|, body: get_resp.to_json
+
+    view_by_type_resp = {
+      total_rows:579,
+      offset:0,
+      rows:[
+        {
+          id:"foo_bar/1",
+          key: "foo_bar",
+          value: {_id: "foo_bar/1", _rev: "FF0000", foo: 'Foo', bar: 'Bar', type: 'foo_bar'},
+          doc: {_id: "foo_bar/1", _rev: "FF0000", foo: 'Foo', bar: 'Bar', type: 'foo_bar'}
+        }
+      ]
+    }
+
+    view_resp = {
+      total_rows:579,
+      offset:0,
+      rows:[
+        {
+          id:"foo_bar/1",
+          key: "foo_bar",
+          value: {_id: "foo_bar/1", _rev: "FF0000", foo: 'Foo', bar: 'Bar'},
+          doc: {_id: "foo_bar/1", _rev: "FF0000", foo: 'Foo', bar: 'Bar'}
+        }
+      ]
+    }
+
+    FakeWeb.register_uri :get, %r|http://.*:5984/test/_design/.*/_view/all.*key=%22foo_bar%22|, body: view_resp.to_json
+
+    FakeWeb.register_uri :get, %r|http://.*:5984/test/_design/.*/_view/by_type.*key=%22foo_bar%22|, body: view_by_type_resp.to_json
+
+    @foo = FooBar.new foo: 'Foo', bar: 'Bar'
+    @foo.save
+  end
+
+  test 'can not instantiate base class' do
+    assert_raise CouchRestAdapter::NotImplementedError do
+      CouchRestAdapter::Base.new
+    end
+  end
+
+  test 'will add class underscorename to id' do
+    assert @foo.id =~ /foo_bar/
+  end
+
+  test 'attributes are available as methods' do
+    assert_equal 'Bar', @foo.bar
+    assert_equal 'Foo', @foo.foo
+  end
+
+  test 'one can update existing attributes' do
+    @foo.foo = 'more'
+    assert_equal 'more', @foo[:foo]
+  end
+
+  test 'update to attr= will persist' do
+    skip "Need to test update methods with mock requests."
+  end
+
+  test 'query all will bring array of Foo instances' do
+    foos = FooBar.all
+    foos.each do |f|
+      assert f.kind_of?(FooBar)
+    end
+  end
+
+  test 'query all_by_type will return array of docs with type set to model name' do
+    bar = FooBar.new foo: 'Bar', bar: 'Foo', type: 'foo_bar'
+    bar.save
+    bars = FooBar.all_by_type
+    bars.each do |doc|
+      assert doc.kind_of?(FooBar)
+      assert_equal 'foo_bar', doc.type
+    end
+  end
+
+  test 'find will work with partial id' do
+    partial_id = @foo.id.sub(/foo\//,'')
+    assert_equal @foo, FooBar.find(partial_id)
+  end
+
+  #TODO: Error handling, reporting
+
+end
+

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config/application.rb

@@ -0,0 +1,27 @@
+require File.expand_path('../boot', __FILE__)
+
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "sprockets/railtie"
+require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "couch_rest_adapter"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+    config.autoload_paths += %W(#{config.root}/lib/couch_rest_adapter)
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,14 @@
+defaults: &defaults
+  host: localhost
+  port: 5984
+  protocol: http
+
+development:
+  <<: *defaults
+  name: test
+
+test:
+  <<: *defaults
+  name: test
+
+

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end