jmoses-couchbase-model 0.5.3

data/lib/couchbase/model/configuration.rb

@@ -0,0 +1,30 @@
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Couchbase
+
+  class Model
+
+    module Configuration
+      extend self
+
+      attr_accessor :design_documents_paths
+    end
+
+  end
+
+end

data/lib/couchbase/model/ext/camelize.rb

@@ -0,0 +1,23 @@
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+class String
+  def camelize
+    res = self.sub(/^[a-z\d]*/) { $&.capitalize }
+    res.gsub(/(?:_|(\/))([a-z\d]*)/i) { "#{$1}#{$2.capitalize}" }.gsub('/', '::')
+  end
+end

data/lib/couchbase/model/ext/constantize.rb

@@ -0,0 +1,29 @@
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+class String
+  def constantize
+    names = self.split('::')
+    names.shift if names.empty? || names.first.empty?
+
+    constant = Object
+    names.each do |name|
+      constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+    end
+    constant
+  end
+end

data/lib/couchbase/model/ext/singleton_class.rb

@@ -0,0 +1,24 @@
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+class Object
+  def singleton_class
+    class << self
+      self
+    end
+  end
+end

data/lib/couchbase/model/uuid.rb

@@ -0,0 +1,113 @@
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'thread'
+
+module Couchbase
+
+  class Model
+
+    # Generator of CouchDB specfic UUIDs. This is the ruby implementation of
+    # couch_uuids.erl from couchdb distribution. It is threadsafe.
+    #
+    # @since 0.0.1
+
+    class UUID
+      # Get default UUID generator. You can create your own if you like.
+      #
+      # @since 0.0.1
+      #
+      # @return [UUID]
+      def self.generator
+        @generator ||= UUID.new
+      end
+
+      # Initialize generator.
+      #
+      # @since 0.0.1
+      #
+      # @param [Fixnum] seed seed for pseudorandom number generator.
+      def initialize(seed = nil)
+        seed ? srand(seed) : srand
+        @prefix, _ = rand_bytes(13).unpack('H26')
+        @inc = rand(0xfff) + 1
+        @lock = Mutex.new
+      end
+
+      # Generate list of UUIDs.
+      #
+      # @since 0.0.1
+      #
+      # @param [Fixnum] count number of UUIDs you need
+      #
+      # @param [Symbol] algorithm Algorithm to use. Known algorithms:
+      #   [:random]
+      #     128 bits of random awesome. All awesome, all the time.
+      #   [:sequential]
+      #     Monotonically increasing ids with random increments.  First 26 hex
+      #     characters are random. Last 6 increment in random amounts until an
+      #     overflow occurs. On overflow, the random prefix is regenerated and
+      #     the process starts over.
+      #   [:utc_random]
+      #     Time since Jan 1, 1970 UTC with microseconds. First 14 characters
+      #     are the time in hex. Last 18 are random.
+      #
+      # @return [String, Array] single string value or array of strings. Where
+      #   each value represents 128-bit number written in hexadecimal format.
+      def next(count = 1, algorithm = :sequential)
+        raise ArgumentError, 'count should be a positive number' unless count > 0
+        uuids = case algorithm
+                when :random
+                  rand_bytes(16 * count).unpack('H32' * count)
+                when :utc_random
+                  now = Time.now.utc
+                  prefix = '%014x' % [now.to_i * 1_000_000 + now.usec]
+                  rand_bytes(9 * count).unpack('H18' * count).map do |tail|
+                    "#{prefix}#{tail}"
+                  end
+                when :sequential
+                  (1..count).map{ next_seq }
+                else
+                  raise ArgumentError, "Unknown algorithm #{algo}. Should be one :sequential, :random or :utc_random"
+                end
+        uuids.size == 1 ? uuids[0] : uuids
+      end
+
+      private
+
+      def next_seq
+        @lock.synchronize do
+          if @inc >= 0xfff000
+            @prefix, _ = rand_bytes(13).unpack('H26')
+            @inc = rand(0xfff) + 1
+          end
+          @inc += rand(0xfff) + 1
+          '%s%06x' % [@prefix, @inc]
+        end
+      end
+
+      def rand_bytes(count)
+        bytes = ''
+        count.times { bytes << rand(256) }
+        bytes
+      end
+
+    end
+
+  end
+
+end

data/lib/couchbase/model/version.rb

@@ -0,0 +1,26 @@
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Couchbase
+
+  class Model
+
+    VERSION = '0.5.3'
+
+  end
+
+end

data/lib/couchbase/railtie.rb

@@ -0,0 +1,142 @@
+# encoding: utf-8
+#
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'couchbase/model'
+
+module Rails #:nodoc:
+  module Couchbase #:nodoc:
+    class Railtie < Rails::Railtie #:nodoc:
+
+      config.couchbase = ActiveSupport::OrderedOptions.new
+      config.couchbase.ensure_design_documents ||= true
+
+      # Determine which generator to use. app_generators was introduced after
+      # 3.0.0.
+      #
+      # @since 0.1.0
+      #
+      # @example Get the generators method.
+      #   railtie.generators
+      #
+      # @return [Symbol] The method name to use.
+      def self.generator
+        config.respond_to?(:app_generators) ? :app_generators : :generators
+      end
+
+      # Maping of rescued exceptions to HTTP responses
+      #
+      # @since 0.1.0
+      #
+      # @example
+      #   railtie.rescue_responses
+      #
+      # @return [Hash] rescued responses
+      def self.rescue_responses
+        {
+          'Couchbase::Error::NotFound' => :not_found,
+          'Couchbase::Error::NotStored' => :unprocessable_entity,
+          'Couchbase::Error::RecordInvalid' => :unprocessable_entity
+        }
+      end
+
+      config.send(generator).orm :couchbase, :migration => false
+
+      if config.action_dispatch.rescue_responses
+        config.action_dispatch.rescue_responses.merge!(rescue_responses)
+      end
+
+      # Initialize Couchbase Mode. This will look for a couchbase.yml in the
+      # config directory and configure Couchbase connection appropriately.
+      #
+      # @example couchbase.yml
+      #
+      #   common: &common
+      #     hostname: localhost
+      #     port: 8091
+      #     username:
+      #     password:
+      #     pool: default
+      #
+      #   production:
+      #     <<: *common
+      #     bucket: example_production
+      #
+      #   test:
+      #     <<: *common
+      #     bucket: example_test
+      #
+      #   development:
+      #     <<: *common
+      #     bucket: example_development
+      #
+      initializer 'couchbase.setup_connection' do
+        config_file = Rails.root.join('config', 'couchbase.yml')
+        if config_file.file? &&
+          config = YAML.load(ERB.new(File.read(config_file)).result)[Rails.env]
+          ::Couchbase.connection_options = config.with_indifferent_access
+        end
+      end
+
+      # After initialization we will warn the user if we can't find a couchbase.yml and
+      # alert to create one.
+      initializer 'couchbase.warn_configuration_missing' do
+        unless ARGV.include?('couchbase:config')
+          config.after_initialize do
+            unless Rails.root.join('config', 'couchbase.yml').file?
+              puts "\nCouchbase config not found. Create a config file at: config/couchbase.yml"
+              puts "to generate one run: rails generate couchbase:config\n\n"
+            end
+          end
+        end
+      end
+
+      # Check (and upgrade if needed) all design documents
+      initializer 'couchbase.upgrade_design_documents', :after => 'couchbase.setup_connection'  do |app|
+        ::Couchbase::Model::Configuration.design_documents_paths ||= app.config.paths['app/models']
+        if config.couchbase.ensure_design_documents
+          config.to_prepare do
+            app.config.paths['app/models'].each do |path|
+              Dir.glob("#{path}/**/*.rb").sort.each do |file|
+                require_dependency(file.gsub("#{path}/" , '').gsub('.rb', ''))
+              end
+            end
+            begin
+              ::Couchbase::Model.descendants.each do |model|
+                model.ensure_design_document!
+              end
+            rescue ::Couchbase::Error::Timeout, ::Couchbase::Error::Connect
+              # skip connection errors for now
+            end
+          end
+        end
+      end
+
+      # Set the proper error types for Rails. NotFound errors should be
+      # 404s and not 500s, validation errors are 422s.
+      initializer 'couchbase.load_http_errors' do |app|
+        config.after_initialize do
+          unless config.action_dispatch.rescue_responses
+            ActionDispatch::ShowExceptions.rescue_responses.update(Railtie.rescue_responses)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/rails/generators/couchbase/config/config_generator.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+#
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'rails/generators/couchbase_generator'
+
+module Couchbase
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      desc 'Creates a Couchbase configuration file at config/couchbase.yml'
+
+      argument :database_name, :type => :string, :optional => true
+
+      def self.source_root
+        @_couchbase_source_root ||= File.expand_path('../templates', __FILE__)
+      end
+
+      def app_name
+        Rails::Application.subclasses.first.parent.to_s.underscore
+      end
+
+      def create_config_file
+        template 'couchbase.yml', File.join('config', 'couchbase.yml')
+      end
+
+    end
+  end
+end

data/lib/rails/generators/couchbase/config/templates/couchbase.yml

@@ -0,0 +1,23 @@
+common: &common
+  hostname: localhost
+  port: 8091
+  username:
+  password:
+  pool: default
+
+development:
+  <<: *common
+  bucket: <%= database_name || app_name %>_development
+
+test:
+  <<: *common
+  bucket: <%= database_name || app_name %>_test
+
+# set these environment variables on your production server
+production:
+  hostname: <%%= ENV['COUCHBASE_HOST'] %>
+  port: <%%= ENV['COUCHBASE_PORT'] %>
+  username: <%%= ENV['COUCHBASE_USERNAME'] %>
+  password: <%%= ENV['COUCHBASE_PASSWORD'] %>
+  pool: <%%= ENV['COUCHBASE_POOL'] %>
+  bucket: <%%= ENV['COUCHBASE_BUCKET'] %>