fakecrm 0.9.9.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e0d190fc0cf9569dd4eb62f2d843db0febd4fa52
+  data.tar.gz: 9ee3ecf7a990ce957dcc1f89df3e53bcc7fb69f4
+SHA512:
+  metadata.gz: 493c700aa1763b86db61f308f44e6eb58e9a9aef17b2a89d116667213597a2028e69810f7e7eb8416d58d13c53beec83cd15d803dce05612a6cd2a2fc288f4df
+  data.tar.gz: 73a8fbf4a74b10cf364ed8221f1f21a9f2501ee2603c247010ddcce706c89e72bb35a0ba590ff07fa92bfa8a766b5997a2971c453de3ea79a53169ea563dd531

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+lib/db.sqlite

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "test/crm_connector"]
+	path = test/crm_connector
+	url = git@github.com:infopark/crm_connector.git

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fakecrm.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mateusz Sojka
+
+MIT License
+
+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,76 @@
+# Fakecrm
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fakecrm', :git => git@github.com:infopark/fakecrm.git
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+You can run this gem as standalone server with:
+
+    $ fakecrm
+
+For help on running this command execute:
+
+    $ fakecrm --help
+
+Another approach is to embed fakecrm directly into your application. The following describes steps neccessary for a rails application.
+
+Assuming you added fakecrm to your application's Gemfile, you need to create an initializer, for example under `config/initializers/fakecrm.rb`:
+
+    # place your Fakecrm configuration here
+    Fakecrm::Configuration.silent = true
+
+    Infopark::Crm.configure do |configuration|
+      configuration.url = "http://localhost:#{Fakecrm::Configuration.port}/crm"
+      configuration.login = "root"
+      configuration.api_key = "deadbeef"
+    end
+
+    require 'fakecrm/embedded'
+    Fakecrm.embedded! if Rails.env.development? || Rails.env.test?
+
+For available configuration options see the output of the command:
+
+    $ fakecrm --help
+
+## Testing
+
+To prepare test environment execute (you must only do it once):
+
+    $ git submodule init
+    $ git submodule update
+
+Execute to update test environment:
+
+    $ git submodule update
+
+Execute this line to run all tests:
+
+    $ rake
+
+Open `coverage/index.html` after running the suite to see a detailed report of code coverage.
+
+You can also run only selected test using:
+
+    $ TEST=test/crm_connector/account_search_custom_field_test.rb rake
+
+**Some bugs only become apparent after the suite has been run two consecutive times. To handle this case execute:**
+
+    $ rake TWICE=1
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,113 @@
+require "bundler/gem_tasks"
+
+module Fakecrm
+  module SimpleTests
+    class Coverage
+      def measure
+        require 'simplecov'
+        SimpleCov.command_name 'test:crm_connector'
+        SimpleCov.start
+      end
+    end
+
+    class EmbeddedTest
+      def app_path
+        @app_path ||= File.expand_path('../test/embedded', __FILE__)
+      end
+
+      def configure
+        File.open(File.join(app_path, 'config/initializers/fakecrm.rb'), 'w') do |f|
+          f.puts <<-EOF
+Infopark::Crm.configure do |configuration|
+  configuration.url = "http://localhost:\#{Fakecrm::Configuration.port}/crm"
+  configuration.login = "root"
+  configuration.api_key = "deadbeef"
+end
+
+require 'fakecrm/embedded'
+Fakecrm.embedded! if Rails.env.development? || Rails.env.test?
+          EOF
+        end
+      end
+
+      def test
+        Dir.chdir(app_path)
+        `bundle > /dev/null && bundle exec rails runner "fail '' unless Infopark::Crm::Contact.search(:params => {:login => 'root'}).first.login == 'root'"`
+        raise "Embedded test failed" unless $?.success?
+      end
+
+      def run
+        $stdout.puts "Running embedded tests"
+        configure
+        test
+        $stdout.puts "Embedded tests successful"
+      end
+    end
+
+    class ConnectorTest
+      def crm_path
+        @crm_path ||= File.expand_path('../test/crm_connector', __FILE__)
+      end
+
+      def load_fakecrm
+        require File.expand_path('../lib/fakecrm', __FILE__)
+        require File.expand_path('../lib/fakecrm/embedded', __FILE__)
+      end
+
+      def configure_connector
+        File.open(File.join(crm_path,'test/local_config.rb'), 'w') do |f|
+          f.write <<-EOS
+require 'helpful_configuration'
+require 'json'
+
+def either_file(*files)
+    found = files.detect do |file|
+          File.exists?(file)
+            end
+      raise "Could not find any of the files \#{files.join(', ')}" unless found
+        found
+end
+
+def local_config
+{
+"login" => "root",
+"api_key" => "deadbeef",
+"url" => "http://localhost:#{Fakecrm::Configuration.port}/crm"
+}
+end
+          EOS
+        end
+      end
+      def test
+        Dir.chdir(crm_path)
+        load File.join(crm_path, 'Rakefile')
+        Rake::Task["test"].invoke
+        Rake::Task["test"].execute if ENV['TWICE']
+      end
+
+      def start_embedded_server
+        require 'fakecrm/embedded'
+        port, pid = Fakecrm.embedded!
+        Fakecrm::Configuration.port = port
+      end
+
+      def run
+        load_fakecrm
+        start_embedded_server
+        configure_connector
+        $stdout.puts "Running connector tests"
+        test
+        $stdout.puts "Connector tests successful"
+      end
+    end
+  end
+end
+
+desc "Tests the gem"
+task :testrun do
+  Fakecrm::SimpleTests::Coverage.new.measure unless ENV['TEST']
+  Fakecrm::SimpleTests::EmbeddedTest.new.run unless ENV['TEST']
+  Fakecrm::SimpleTests::ConnectorTest.new.run
+end
+
+task :default => :testrun

data/bin/fakecrm

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'rubygems'
+require 'bundler'
+require 'bundler/setup'
+
+begin
+  require 'fakecrm'
+rescue LoadError => e
+  require File.expand_path('../../lib/fakecrm', __FILE__)
+end
+
+conf = Fakecrm::Configuration
+OptionParser.new do |opts|
+  opts.banner = "Usage: fakecrm [options]"
+
+  opts.on("-s", "--silent", "Run silently (disable any output)") do |s|
+    conf.silent = true
+  end
+
+  opts.on("-l", "--log-level [LEVEL]", [:fatal, :error, :warn, :info, :debug], "Select log level (off, fatal, error, warn, info, debug, default=#{conf.log_level})") do |l|
+    conf.log_level = l
+  end
+
+  opts.on("-p", "--port [PORT]", OptionParser::DecimalNumeric, "Select port to run on (default #{conf.port})") do |p|
+    conf.port = p
+  end
+
+  opts.on("-d", "--database [DATABASE", "Setup database to use fakecrm with, for example:", "#{conf.database} (default)", "mysql://user:password@hostname/database","postgres://user:password@hostname/database") do |d|
+    conf.database = d
+  end
+
+end.parse!
+
+
+Fakecrm.run!

data/fakecrm.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fakecrm/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fakecrm"
+  spec.version       = Fakecrm::VERSION
+  spec.authors       = ["Mateusz Sojka", "Tomasz Przedmojski"]
+  spec.email         = ["mateusz.sojka@infopark.de", "tomasz.przedmojski@infopark.de"]
+  spec.description   = %q{FakeCRM is a mock implementation for the Infopark WebCRM. It can be used for offline local development and automated testing.}
+  spec.summary       = %q{FakeCRM is a mock implementation for the Infopark WebCRM.}
+  spec.homepage      = "https://github.com/infopark/fakecrm"
+  spec.license       = "LGPLv3"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "simplecov"
+  spec.add_dependency 'dm-sqlite-adapter'
+  spec.add_dependency 'json'
+  spec.add_dependency 'sinatra'
+  spec.add_dependency 'rack-contrib'
+  spec.add_dependency 'thin'
+  spec.add_dependency 'i18n'
+  spec.add_dependency 'data_mapper'
+end
+

data/lib/fakecrm/application.rb

@@ -0,0 +1,85 @@
+require 'fakecrm/configuration'
+require 'fakecrm/server'
+
+module Fakecrm
+  class Application
+    include Singleton
+
+    def configure
+      configure_logger
+      configure_dm
+      configure_server
+    end
+
+    def configure_logger
+      level_map = {
+        :info => Logger::INFO,
+        :debug => Logger::DEBUG,
+        :warn => Logger::WARN,
+        :error => Logger::ERROR,
+        :fatal => Logger::FATAL
+      }
+
+      if Configuration.silent
+        Thin::Logging.silent = true
+        DataMapper::Logger.new($stderr, :fatal)
+        self.logger = Logger.new(nil)
+      else
+        DataMapper::Logger.new($stderr, Configuration.log_level)
+        self.logger = Logger.new($stderr, level_map[Configuration.log_level])
+      end
+
+      # replace sinatra logger
+      Fakecrm::Server.disable :logging
+      Fakecrm::Server.use Rack::CommonLogger, self.logger
+    end
+
+    def load_and_initialize
+      logger.debug("Loading resources")
+      require 'fakecrm/resources'
+      logger.debug("Initializing resources")
+      require 'fakecrm/initialize'
+    end
+
+    def configure_dm
+      logger.debug("Configuring default database to: #{Configuration.database}")
+      DataMapper.setup(:default, Configuration.database)
+      logger.debug("Configuring localizations")
+      I18n.load_path += Dir[File.join(File.dirname(__FILE__), '../../locales', '*.yml').to_s]
+      logger.debug("Using i18n files: #{I18n.load_path.inspect}")
+      require 'fakecrm/localized_dm'
+    end
+
+    def configure_server
+      logger.debug("Configuring server to run on port #{Configuration.port}")
+      Fakecrm::Server.set :port, Configuration.port
+      logger.debug("Switching do production environment")
+      Fakecrm::Server.set :environment, :production
+    end
+
+    def prepare!
+      configure
+      load_and_initialize
+    end
+
+    def run!
+      prepare!
+      start_server
+    end
+
+    def start_server
+      Fakecrm::Server.run!
+    end
+
+    def logger
+      if !@logger
+        $stderr.puts("Warning: Logger has not been configured! Defaulting to nil logger")
+        self.logger = Logger.new(nil)
+      end
+      @logger
+    end
+
+    protected
+    attr_writer :logger
+  end
+end

data/lib/fakecrm/configuration.rb

@@ -0,0 +1,8 @@
+# -*- encoding : utf-8 -*-
+require 'singleton'
+module Fakecrm
+  Configuration = Struct
+    .new(:database, :port, :log_level, :silent)
+    .new("sqlite3:///tmp/fakecrm.sqlite3", 3276, :debug, false)
+end
+

data/lib/fakecrm/drop.rb

@@ -0,0 +1,59 @@
+# -*- encoding : utf-8 -*-
+module Fakecrm
+  module Drop
+    def create_one(resource, data)
+      response = {}
+      resource.transaction do |t|
+        instance = resource.new
+        instance.attributes = data
+
+        if instance.save
+          response = instance
+        else
+          status 422
+          response = instance.errors.to_hash
+        end
+      end
+
+      response.to_json
+    rescue ArgumentError => e
+      status 422
+      ::Fakecrm.logger.error("Unable to set unknown attribute: #{e.inspect}")
+      {:error => "Unknown attribute"}.to_json 
+    end
+
+    def update_one(resource, primary_key, data)
+      response = {}
+      resource.transaction do |t|
+        instance = resource.get!(primary_key)
+        ::Fakecrm.logger.debug("Updating resource with: #{data.inspect}")
+        instance.attributes = data
+        if instance.save
+          response = {}
+        else
+          status 422
+          ::Fakecrm.logger.debug("Updating resouce failed: #{instance.errors.to_hash.inspect}")
+          response = instance.errors.to_hash
+        end
+      end
+
+      body response.to_json
+    rescue ::DataMapper::ObjectNotFoundError
+      status 404
+    rescue ArgumentError => e
+      status 422
+      ::Fakecrm.logger.error("Unable to set unknown attribute: #{e.inspect}")
+      {:error => "Unknown attribute"}.to_json 
+    end
+
+    def destroy_one(resource, primary_key)
+      resource.transaction do |t|
+        resource.get!(primary_key).destroy
+      end
+      body {}.to_json
+    rescue ::DataMapper::ObjectNotFoundError
+      status 404
+    end
+  end
+end
+

data/lib/fakecrm/embedded.rb

@@ -0,0 +1,32 @@
+module Fakecrm
+  def self.embedded!
+    require 'fakecrm/configuration'
+
+    port = 4000 + rand(10000)
+    url  = "http://localhost:#{port}/crm"
+
+    if defined?(Infopark::Crm)
+      Infopark::Crm.configure do |configuration|
+        configuration.url = url
+        configuration.login = "root"
+        configuration.api_key = "deadbeef"
+      end
+    end
+
+    pid = fork do
+      require 'fakecrm'
+      Fakecrm::Configuration.port = port
+      Fakecrm::Configuration.database = 'sqlite::memory:'
+      Fakecrm::Configuration.silent = true
+      self.run!
+      exit!
+    end
+    sleep(1)
+    at_exit do
+      Process.kill("INT", pid)
+      Process.wait(pid)
+    end
+
+    return [port, pid]
+  end
+end

data/lib/fakecrm/fetch.rb

@@ -0,0 +1,139 @@
+# -*- encoding : utf-8 -*-
+require 'fakecrm/resource/views/resource_view'
+
+module Fakecrm
+  module Fetch
+    def continuation
+      JSON.parse(Base64.decode64(params.fetch("continuation_handle", "e30=")))
+    rescue => exception
+      {}
+    end
+
+    def build_continuation
+      Base64.urlsafe_encode64(params.merge({:offset => offset+limit, :limit => limit, :include_deleted => include_deleted?.to_s}).to_json)
+    end
+
+    def limit
+      limit = params.fetch("limit", continuation.fetch("limit", "10")).to_i
+      (1..1000).include?(limit) ? limit : 10
+    end
+
+    def offset
+      continuation.fetch("offset", 0).to_i
+    end
+
+    def include_deleted?
+      "true" == continuation.fetch("include_deleted", params.fetch("include_deleted", "false")).to_s
+    end
+
+    def consider_deleted(resource)
+      if include_deleted?
+        resource.with_deleted
+      else
+        resource
+      end
+    end
+
+
+    def search(resource, builtins=[], full_text_fields=[], sort_by = nil, sort_order = 'asc')
+      options = {}
+      builtins.each do |built_in_field|
+        options[built_in_field.to_sym] = params[built_in_field.to_s] if params.key?(built_in_field.to_s)
+
+      end
+
+      custom_fields = []
+      resource.properties.each do |property|
+        custom_fields << property.name if property.name =~ /^custom/
+      end
+
+      # custom fields
+      params.each do |key, value|
+        if key =~ /^custom_/
+          options[key] = value
+        elsif key =~ /_id$/
+          # cast ids to integers
+          options[key.to_sym] = value.to_i
+        end
+      end
+
+      # full text
+      if params.key?('q')
+        fields = []
+        values = []
+        (full_text_fields + custom_fields).each do |full_text_field|
+          queries = params['q'].split(/\s/)
+
+          sub_fields = []
+          queries.each do |query|
+            sub_fields << "(#{full_text_field} LIKE ?)"
+            values << "%#{query}%"
+          end
+          fields << (" ( " + sub_fields.join(" OR ") + " ) ") unless sub_fields.empty?
+        end
+        if !fields.empty?
+          options[:conditions] = [fields.join(' OR ')] + values
+        end
+      end
+
+      # Reject empty options to mimic WebCRM
+      options = options.reject { |_, value| value.nil? || value == '' }
+
+      query = resource.all(options)
+      # FIXME: code duplication (fetch_many)
+      total_count = query.count
+      remaining_count = total_count - offset
+
+      query_options = { :limit => limit, :offset => offset }
+
+      if sort_by
+        sort_order ||= 'asc'
+        sort_order = 'asc' unless ['asc', 'desc'].include?(sort_order.downcase)
+        if sort_by.to_sym == :updated_at
+          order = { :order => [sort_by.to_sym.send(sort_order.to_sym), :id.send(sort_order.to_sym)] }
+        else
+          order = { :order => sort_by.to_sym.send(sort_order.to_sym) }
+        end
+
+        query_options.merge!(order)
+      end
+
+      result = {:results => query.all(query_options), :total => total_count}
+
+      if remaining_count > limit
+        result["continuation_handle"] = build_continuation
+      end
+
+      status 200
+      body result.to_json
+    end
+
+    def fetch_many(resource)
+      query = consider_deleted(resource)
+      remaining_count = query.count - offset
+      result = {:results => ResourceView.decorate(query.all(:limit => limit, :offset => offset)) }
+
+      if remaining_count > limit
+        result["continuation_handle"] = build_continuation
+      end
+
+      status 200
+      body result.to_json
+    end
+
+    def fetch_one(resource, primary_key)
+      begin
+        status 200
+        if resource.respond_to? :with_deleted
+          body ResourceView.decorate(resource.with_deleted.get!(primary_key)).to_json
+        else
+          body ResourceView.decorate(resource.get!(primary_key)).to_json
+        end
+      rescue ::DataMapper::ObjectNotFoundError => e
+        status 404
+      end
+    end
+
+  end
+end
+

data/lib/fakecrm/initialize.rb

@@ -0,0 +1,16 @@
+# -*- encoding : utf-8 -*-
+DataMapper.auto_upgrade!
+
+contact = Fakecrm::Contact.first_or_create(:last_name => 'root', :login => 'root', :gender => 'N', :language => 'en', :email => 'root@root.org')
+Fakecrm::Password.first_or_create(:password => 'root', :contact => contact)
+
+
+Fakecrm::CustomType.first_or_create(:name => 'contact', :kind => 'Contact')
+
+Fakecrm::CustomType.first_or_create(:name => 'account', :kind => 'Account')
+
+Fakecrm::CustomType.all.each do |custom_type|
+  Fakecrm::TypeExtender.new(custom_type).extend!
+end
+
+

data/lib/fakecrm/localized_dm.rb

@@ -0,0 +1,12 @@
+class DataMapper::Validations::ValidationErrors
+  def self.default_error_message(key, field, *values)
+    begin
+      message = I18n.t!(:"messages.#{key}") 
+    rescue
+      ::Fakecrm.logger.debug("Translation for message key #{key} not found (locale=#{I18n.locale})")
+      message = @@default_error_messages[key]
+    end
+    field = DataMapper::Inflector.humanize(field)
+    message % [field, *values].flatten
+  end
+end