active_harmony 1.0.1

data/.bundle/config

@@ -0,0 +1,2 @@
+--- 
+BUNDLE_DISABLE_SHARED_GEMS: "1"

data/CHANGELOG

@@ -0,0 +1,5 @@
+1.0.1
+Fixes in Gemfile that caused problems with WebMock.
+
+1.0.0
+Initial version

data/Gemfile

@@ -0,0 +1,13 @@
+source 'http://gemcutter.org'
+
+gem "bundler", "~> 1.0.0"
+
+gem 'mongoid',  '>= 2.0.0.beta.17'
+gem 'bson_ext', '1.0.4'
+
+group :development do
+  gem 'jeweler'
+  gem 'rspec', '>= 2.0.0.beta.22'
+  gem 'webmock'
+  gem 'mocha'
+end

data/Gemfile.lock

@@ -0,0 +1,62 @@
+GEM
+  remote: http://gemcutter.org/
+  specs:
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activesupport (3.0.0)
+    addressable (2.2.1)
+    bson (1.0.4)
+    bson_ext (1.0.4)
+    builder (2.1.2)
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    gemcutter (0.6.1)
+    git (1.2.5)
+    i18n (0.4.1)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.6)
+    mocha (0.9.8)
+      rake
+    mongo (1.0.7)
+      bson (>= 1.0.4)
+    mongoid (2.0.0.beta.18)
+      activemodel (~> 3.0.0)
+      bson (= 1.0.4)
+      mongo (= 1.0.7)
+      tzinfo (~> 0.3.22)
+      will_paginate (~> 3.0.pre)
+    rake (0.8.7)
+    rspec (2.0.0.beta.22)
+      rspec-core (= 2.0.0.beta.22)
+      rspec-expectations (= 2.0.0.beta.22)
+      rspec-mocks (= 2.0.0.beta.22)
+    rspec-core (2.0.0.beta.22)
+    rspec-expectations (2.0.0.beta.22)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.22)
+      rspec-core (= 2.0.0.beta.22)
+      rspec-expectations (= 2.0.0.beta.22)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    tzinfo (0.3.23)
+    webmock (1.3.5)
+      addressable (>= 2.1.1)
+      crack (>= 0.1.7)
+    will_paginate (3.0.pre2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bson_ext (= 1.0.4)
+  bundler (~> 1.0.0)
+  jeweler
+  mocha
+  mongoid (>= 2.0.0.beta.17)
+  rspec (>= 2.0.0.beta.22)
+  webmock

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Vojto Rinik
+
+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.markdown

@@ -0,0 +1,110 @@
+# Active Harmony
+
+## What does it do
+
+Active Harmony is a Ruby library for synchronizing Ruby objects with remote REST services. 
+
+Synchronizing just objects doesn't make much sense - so Active Harmony expects that you will use some persistance layer for your Ruby objects. For now, we support Mongoid, but you can easily code support for your favorite persistance layer. (Mongoid support is 30 lines - see synchronizable/harmony.rb)
+
+## How to use it
+
+### Installing
+
+First, add Active Harmony to your Gemfile
+
+    gem 'active_harmony', :git => 'git://github.com/vojto/active_harmony.git'
+    
+### Setting up services
+
+Before you move on to your objects, you need to setup a remote service. 
+
+Start by initializing new Service Manager. This will be object that knows about all services. If you're using Rails, you can add this to your initializers:
+
+    SERVICE_MANAGER = ActiveHarmony::ServiceManager.new
+    
+You will need to access manager in your models later - to setup synchronization with the service. But, customize your service first:
+
+    my_service.base_url = 'http://myservice.com/api'
+    my_service.header['MyServiceKey'] = 'abcdef'
+    
+Service allows more customization, like adding authentication, changing paths, and so on. See documentation for ActiveHarmony::Service for more information. 
+
+You might want to know, that service supports only XML type of requests/responses for now. XML path for finding entities in XML responses is also one of the things you can customize on Service class.
+
+Now you need to add your newly created service to your manager.
+
+    SERVICE_MANAGER.add_service_for_identifier(my_service, :my_service)
+
+### Setting up Ruby objects
+
+Setup your Ruby object that will by synced. These lines set up persistence using Mongoid and include two classes from Active Harmony: Core adds basic synchronizable functionality, and Mongoid extends this to Mongoid persistence layer.
+
+    class Bacon
+      include Mongoid::Document
+      
+      include ActiveHarmony::Synchronizable::Core
+      include ActiveHarmony::Synchronizable::Mongoid
+      
+      field :tastyness
+    end
+    
+    
+
+### Assigning Service to Ruby objects
+
+Now you have added services to your managers, and added synchronization capabilities to your objects. Last step is wiring things up together.
+
+A good place to do this is your model, you'll see why:
+
+    class Bacon
+      synchronizer.service = \
+        SERVICE_MANAGER.service_with_identifier :my_service
+        
+      synchronizer.configure do |config|
+        config.synchronize :tastyness
+      end
+    end
+    
+As you can see, you're using class variable __synchronizer__. This variable was initialized for you when you included _Synchronizable::Core_, so you can change Service, or configure synchronizable fields.
+
+### Synchronizing objects
+
+Check out documentation of _Synchronizable::Core_ for methods you can use directly on your objects, or check out _Synchronizer_ class that has methods like pulling whole collection from remote server.
+
+Here's a simple example of pushing local changes:
+
+    chunky_bacon = Bacon.first
+    chunky_bacon.push
+    ActiveHarmony::Queue.instance.run
+    
+Please note that using Queue requires Mongoid. If you want to do an instant push, you can pass in true as argument to push:
+
+    chunky_bacon.push(true)
+
+# License
+
+Copyright (c) 2010 Vojto Rinik
+
+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.
+
+# Credits
+
+* Vojto Rinik: vojto (at) rinik (dot) net
+* Ryan Smith: ryandotsmith (at) gmail (dot) com

data/Rakefile

@@ -0,0 +1,14 @@
+require 'jeweler'
+
+begin
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "active_harmony"
+    gemspec.summary = "Ruby synchronization with REST services"
+    gemspec.description = "Active Harmony is a Ruby library that takes care of synchronizing changes between local Ruby objects and remote REST services."
+    gemspec.email = "vojto@rinik.net"
+    gemspec.homepage = "http://github.com/vojto/active_harmony"
+    gemspec.authors = ["Vojto Rinik"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.1

data/active_harmony.gemspec

@@ -0,0 +1,77 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{active_harmony}
+  s.version = "1.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Vojto Rinik"]
+  s.date = %q{2010-09-22}
+  s.description = %q{Active Harmony is a Ruby library that takes care of synchronizing changes between local Ruby objects and remote REST services.}
+  s.email = %q{vojto@rinik.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".bundle/config",
+     "CHANGELOG",
+     "Gemfile",
+     "Gemfile.lock",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "active_harmony.gemspec",
+     "lib/active_harmony.rb",
+     "lib/active_harmony/queue.rb",
+     "lib/active_harmony/queue_item.rb",
+     "lib/active_harmony/service.rb",
+     "lib/active_harmony/service_manager.rb",
+     "lib/active_harmony/service_url.rb",
+     "lib/active_harmony/synchronizable.rb",
+     "lib/active_harmony/synchronizable/core.rb",
+     "lib/active_harmony/synchronizable/mongoid.rb",
+     "lib/active_harmony/synchronizer.rb",
+     "lib/active_harmony/synchronizer_configuration.rb",
+     "spec/spec_helper.rb",
+     "spec/unit/active_harmony/queue_item_spec.rb",
+     "spec/unit/active_harmony/queue_spec.rb",
+     "spec/unit/active_harmony/service_manager_spec.rb",
+     "spec/unit/active_harmony/service_spec.rb",
+     "spec/unit/active_harmony/synchronizable/core_spec.rb",
+     "spec/unit/active_harmony/synchronizable/mongoid_spec.rb",
+     "spec/unit/active_harmony/synchronizer_configuration_spec.rb",
+     "spec/unit/active_harmony/synchronizer_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/vojto/active_harmony}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Ruby synchronization with REST services}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/unit/active_harmony/queue_item_spec.rb",
+     "spec/unit/active_harmony/queue_spec.rb",
+     "spec/unit/active_harmony/service_manager_spec.rb",
+     "spec/unit/active_harmony/service_spec.rb",
+     "spec/unit/active_harmony/synchronizable/core_spec.rb",
+     "spec/unit/active_harmony/synchronizable/mongoid_spec.rb",
+     "spec/unit/active_harmony/synchronizer_configuration_spec.rb",
+     "spec/unit/active_harmony/synchronizer_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/active_harmony.rb

@@ -0,0 +1,14 @@
+require 'mongoid'
+
+require 'active_harmony/queue'
+require 'active_harmony/queue_item'
+require 'active_harmony/service'
+require 'active_harmony/service_manager'
+require 'active_harmony/service_url'
+require 'active_harmony/synchronizable'
+require 'active_harmony/synchronizer'
+require 'active_harmony/synchronizer_configuration'
+
+module ActiveHarmony
+  mattr_accessor :logger
+end

data/lib/active_harmony/queue.rb

@@ -0,0 +1,50 @@
+module ActiveHarmony
+  class Queue
+    include Singleton
+  
+    ##
+    # Queues object for push
+    # @param [Object] Object
+    def queue_push(object)
+      queue_item = QueueItem.new( :kind => "push",
+                                  :object_type => object.class.name,
+                                  :object_local_id => object.id,
+                                  :state => "new" )
+      queue_item.save
+    end
+    
+    ##
+    # Queues object for pull
+    # @param [Class] Class of object
+    # @param [String] Remote ID for object
+    def queue_pull(object_class, remote_id)
+      queue_item = QueueItem.new( :kind => "pull",
+                                  :object_type => object_class.name,
+                                  :object_remote_id => remote_id,
+                                  :state => "new" )
+      queue_item.save
+    end
+  
+    ##
+    # Runs queue
+    def run
+      queued_items.each do |item|
+        item.process_item
+      end
+    end
+    
+    ##
+    # Returns queued items
+    # @return [Array<QueueItem>] Queued Items
+    def queued_items
+      QueueItem.where(:state => "new").all
+    end
+    
+    ##
+    # Returns true if there are any items in queue
+    # @return [Boolean] Should run
+    def should_run?
+      queued_items.count > 0
+    end
+  end
+end

data/lib/active_harmony/queue_item.rb

@@ -0,0 +1,48 @@
+module ActiveHarmony
+  class QueueItem
+    include Mongoid::Document
+
+    field :kind
+    field :state
+    field :result
+
+    field :object_type
+    field :object_remote_id
+    field :object_local_id
+      
+    ##
+    # Processes queued item
+    def process_item
+      if kind == "push"
+        self.process_push
+      elsif kind == "pull"
+        self.process_pull
+      else
+        raise "Unrecognized Queue kind #{kind}"
+      end
+    end
+    
+    ##
+    # Processes queued item of type push
+    def process_push
+      factory = "::#{object_type}".constantize
+      local_object = factory.find(object_local_id)
+      syncer = factory.synchronizer
+      syncer.push_object(local_object)
+      
+      self.state = 'done'
+      self.save
+    end
+    
+    ##
+    # Processes queued item of type pull
+    def process_pull
+      factory = "::#{object_type}".constantize
+      syncer = factory.synchronizer
+      syncer.pull_object(self.object_remote_id)
+      
+      self.state = 'done'
+      self.save
+    end
+  end
+end

data/lib/active_harmony/service.rb

@@ -0,0 +1,293 @@
+module ActiveHarmony
+  class Service
+    attr_accessor :base_url, :header, :root, :auth
+
+    ############################################################
+    # Initialization & Configuration
+
+    ##
+    # Initializes new Rest Service
+    def initialize
+      @header = {}
+      @contexts = {}
+      @paths = []
+      @object_names = []
+      @root = nil
+    end
+
+    ##
+    # Adds header
+    # @param [String] Header name
+    # @param [String] Header value
+    def set_header(name, value)
+      @header[name] = value
+    end
+
+    ############################################################
+    # Generating URLs
+
+    ##
+    # Generates url for REST service
+    # @param [Symbol] Action: show, list, update or destroy
+    # @param [Symbol] Object type
+    # @param [Integer] Object ID
+    # @return [Service::ServiceUrl] Generated URL
+    def generate_rest_url(action, object_type, object_id = nil)
+      url = custom_url_for(object_type, action)
+
+      method = if action == :list || action == :show
+        :get
+      elsif action == :create
+        :post
+      elsif action == :update
+        :put
+      end
+
+      if url
+        url.request_method ||= method
+        if object_id
+          url.path.sub!(':id', object_id.to_s)
+        end
+        return url if url
+      end
+
+      path = ''
+      path += @contexts.collect { |name, value|
+        "#{name}/#{value}"
+      }.join('/')
+      path += '/'
+      if action == :list || action == :create
+        path += object_type.to_s.pluralize
+      elsif action == :show || action == :update
+        path += "#{object_type.to_s.pluralize}/#{object_id.to_s}"
+      end
+      url = generate_url(path)
+
+      ServiceUrl.new(url, method)
+    end
+
+    ##
+    # Generates URL for path using base_url
+    # @param [String] Path
+    # @return [String] URL
+    def generate_url(path)
+      if path =~ /^\//
+        path.sub!('/', '')
+      end
+      path = "#{@base_url}/#{path}"
+    end
+
+    ############################################################
+    # Retrieving data from networks
+
+    ##
+    # Retrieves data from URL
+    # @param [String] URL
+    # @return [String] Retrieved data from the URL
+    def retrieve(url, method = :get, headers = {}, data = nil)
+      puts "[ActiveHarmony] Retrieving data:"
+      puts "[ActiveHarmony]    URL:      #{url}"
+      puts "[ActiveHarmony]    Method:   #{method}"
+      puts "[ActiveHarmony]    Headers:  #{headers.inspect}"
+      puts "[ActiveHarmony]    Data:     #{data.inspect}"
+      if defined?(Rails) && !Rails.env.test?
+        data = retrieve_with_typhoeus(url, method, headers, data)
+      else
+        data = retrieve_with_http(url, method, headers, data)
+      end
+      data
+    end
+
+    def retrieve_with_typhoeus(url, method, headers, data)
+      request_options = {:headers => @header.merge(headers),
+                        :body => data}
+      request_options.merge!(auth) if auth
+      # puts request_options
+      response = Typhoeus::Request.send(method, url, request_options)
+      response.body
+    end
+
+    def retrieve_with_http(url, method, headers, data)
+      url = URI.parse(url)
+      response = nil
+      headers = @header.merge(headers)
+      Net::HTTP.start(url.host, url.port) do |http|
+        if method == :get
+          response = http.get(url.path, headers).body
+        elsif [:put, :post].include?(method)
+          response = http.send(method, url.path, data, headers).body
+        end
+      end
+      response
+    end
+
+    ############################################################
+    # Parsing response
+
+    ##
+    # Parses XML
+    # @param [String] XML
+    # @return [Array<Hash>] Parsed XML in Ruby primitives
+    def parse_xml(xml_string)
+      return {} if xml_string.blank?
+      begin
+        Hash.from_xml(xml_string)
+      rescue Exception => e
+        return {}
+      end
+    end
+
+    def find_object_in_result(result, object_type, action)
+      data = result
+      # puts result
+      if @root
+        @root.split('/').each do |branch|
+          break if data.nil?
+          data = data[branch]
+        end
+        data
+      else
+        path = if action == :list
+          object_type.to_s.pluralize
+        else
+          object_type.to_s
+        end
+        data[path] # Pluralize? When? action?
+      end
+    end
+
+    ############################################################
+    # Working with REST services
+
+    ##
+    # List collection of remote objects
+    # @param [Symbol] Object type
+    # @return [Array<Hash>] Array of objects
+    def list(object_type)
+      url = generate_rest_url(:list, object_type)
+      result = retrieve(url.path)
+      parsed_result = parse_xml(result)
+      find_object_in_result(parsed_result, object_type, :list)
+    end
+
+    ##
+    # Shows remote object
+    # @param [Symbol] Object type
+    # @param [String] Object ID
+    # @return [Hash] Object
+    def show(object_type, id)
+      url = generate_rest_url(:show, object_type, id)
+      result = retrieve(url.path)
+      parsed_result = parse_xml(result)
+      find_object_in_result(parsed_result, object_type, :show)
+    end
+
+    ##
+    # Updates remote object
+    # @param [Symbol] Object type
+    # @param [String] Object ID
+    # @param [Hash] Data to be sent
+    def update(object_type, id, data)
+      url = generate_rest_url(:update, object_type, id)
+      object_name = object_name_for(object_type, :update)
+      xml_data = data.to_xml(:root => object_name, :skip_instruct => true, :dasherize => false)
+      result = retrieve(url.path, url.method, {'Content-type' => 'application/xml'}, xml_data)
+      find_object_in_result(result, object_type, :update)
+    end
+
+    ##
+    # Creates a new remote object
+    # @param [Symbol] Object type
+    # @param [Hash] Data to be sent
+    def create(object_type, data)
+      url = generate_rest_url(:create, object_type)
+      object_name = object_name_for(object_type, :create)
+      xml_data = data.to_xml(:root => object_name, :skip_instruct => true, :dasherize => false)
+      result = retrieve(url.path, url.method, {'Content-type' => 'application/xml'}, xml_data)
+      parsed_result = parse_xml(result)
+      find_object_in_result(parsed_result, object_type, :create)
+    end
+
+    ############################################################
+    # Setting contexts
+
+    ##
+    # Set contexts for service
+    # @param [Hash] Contexts
+    def set_contexts(contexts)
+      contexts.each do |name, value|
+        @contexts[name.to_sym] = value
+      end
+    end
+
+    ##
+    # Clears contexts for service
+    def clear_contexts
+      @contexts = {}
+    end
+
+    ############################################################
+    # Setting custom URLs
+
+    ##
+    # Adds custom path
+    # @param [Symbol] Object type
+    # @param [Symbol] Action
+    # @param [String] Path
+    def add_custom_url(object_type, action, path, method = nil)
+      @paths << {
+        :object_type => object_type,
+        :action => action,
+        :path => path,
+        :method => method
+      }
+    end
+
+    ##
+    # Returns custom path
+    # @param [Symbol] Object type
+    # @param [Symbol] Action
+    # @return [Service::ServiceUrl] Custom path
+    def custom_url_for(object_type, action)
+      path = @paths.find do |path|
+        path[:object_type] == object_type &&
+        path[:action] == action
+      end
+      if path
+        ServiceUrl.new(generate_url(path[:path]), path[:method])
+      end
+    end
+
+    ############################################################
+    # Setting custom object names for objects
+
+    ##
+    # Adds new name for some type of object
+    # @param [Symbol] Object type
+    # @param [Symbol] Action
+    # @param [String] New object name
+    def add_object_name(object_type, action, new_object_name)
+      @object_names << {
+        :object_type => object_type,
+        :action => action,
+        :new_object_name => new_object_name.to_s
+      }
+    end
+
+    ##
+    # Returns custom object name for action
+    # @param [Symbol] Object type
+    # @param [Symbol] Action
+    def object_name_for(object_type, action)
+      object_name = @object_names.find do |object_name|
+        object_name[:object_type] == object_type
+        object_name[:action] == action
+      end
+      object_name = object_name ? object_name[:new_object_name] : nil
+      unless object_name
+        object_name = object_type.to_s.gsub('-', '_')
+      end
+      object_name
+    end
+  end
+end