ofsys 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f999d360b1138a8187c4c4692ddd0f3bb57e5aff
+  data.tar.gz: bef1207e4b668e54f1aacec44d687e558b7608bf
+SHA512:
+  metadata.gz: 241eeb2fe1c96bbee9cea8780f9bfd217603627fed69b0b5cdbd0cd2f5657f20309d01e05723c2b4627245df02521b6adaecdfb6f2ecfe7eeae261abacdd30ac
+  data.tar.gz: 68e8c432d75459da5784b9648eac16c5abc81cf8c69b6062ac931489bd293803529036fe7cdb6711d6dc6f935b2f4503164351924c48daf981d5e866e60b0700

data/Rakefile

@@ -0,0 +1,23 @@
+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    = 'Ofsys'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/ofsys/config.rb

@@ -0,0 +1,13 @@
+module Ofsys
+  DefaultConfig = Struct.new(:id_key, :key, :id_project)
+
+  def self.configure
+    @config = DefaultConfig.new
+    yield(@config) if block_given?
+    @config
+  end
+
+  def self.config
+    @config || configure
+  end
+end

data/lib/ofsys/request/base.rb

@@ -0,0 +1,72 @@
+require 'yajl'
+
+module Ofsys
+  module Request
+    class Base
+      class FailedError < RuntimeError; end
+
+      def initialize(config = Ofsys.config)
+        @id_key = config.id_key
+        @key = config.key
+        @id_project = config.id_project
+      end
+
+      def perform(params = {})
+        request.body = body(params)
+        result_body = http.request(request).body
+        decode_result(result_body)
+      end
+
+      private
+
+      ENDPOINT_BASE = 'https://ofsys.com/webservices/ofc4'.freeze
+
+      def request
+        @request ||= Net::HTTP::Post.new(uri.request_uri)
+      end
+
+      def uri
+        @uri ||= URI.parse(self.class::ENDPOINT)
+      end
+
+      def http
+        @http ||= build_http
+      end
+
+      def build_http
+        Net::HTTP.new(uri.host, uri.port).tap do |http|
+          http.use_ssl = true
+        end
+      end
+
+      def body(source_params)
+        params = merge_auth(source_params)
+        to_json(params)
+      end
+
+      def to_json(hash)
+        ::Yajl::Encoder.encode(hash)
+      end
+
+      def to_hash(text)
+        ::Yajl::Parser.parse(text)
+      end
+
+      def merge_auth(source_params)
+        source_params.merge!(
+          AuthKey: {
+            Key: @key,
+            idKey: @id_key
+          },
+          idProject: @id_project
+        )
+      end
+
+      def decode_result(body)
+        result = to_hash(body)
+        fail FailedError.new(body) unless result['Success']
+        result
+      end
+    end
+  end
+end

data/lib/ofsys/request/contacts_delete.rb

@@ -0,0 +1,7 @@
+module Ofsys
+  module Request
+    class ContactsDelete < Ofsys::Request::Base
+      ENDPOINT = "#{ENDPOINT_BASE}/contacts.ashx?method=Delete".freeze
+    end
+  end
+end

data/lib/ofsys/request/contacts_merge.rb

@@ -0,0 +1,7 @@
+module Ofsys
+  module Request
+    class ContactsMerge < Ofsys::Request::Base
+      ENDPOINT = "#{ENDPOINT_BASE}/contacts.ashx?method=Merge".freeze
+    end
+  end
+end

data/lib/ofsys/request/sendings_send_single.rb

@@ -0,0 +1,7 @@
+module Ofsys
+  module Request
+    class SendingsSendSingle < Ofsys::Request::Base
+      ENDPOINT = "#{ENDPOINT_BASE}/sendings.ashx?method=SendSingle".freeze
+    end
+  end
+end

data/lib/ofsys/request.rb

@@ -0,0 +1,9 @@
+module Ofsys
+  module Request
+  end
+end
+
+require 'ofsys/request/base'
+require 'ofsys/request/contacts_delete'
+require 'ofsys/request/contacts_merge'
+require 'ofsys/request/sendings_send_single'

data/lib/ofsys/version.rb

@@ -0,0 +1,3 @@
+module Ofsys
+  VERSION = '0.0.3'
+end

data/lib/ofsys.rb

@@ -0,0 +1,5 @@
+module Ofsys
+end
+
+require 'ofsys/config'
+require 'ofsys/request'

data/spec/config_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Ofsys do
+  context 'known keys' do
+    it 'assigns config variables' do
+      described_class.configure do |config|
+        config.id_key = 'key1'
+        config.key = 'key2'
+        config.id_project = 'key3'
+      end
+
+      expect(described_class.config.id_key).to eq('key1')
+      expect(described_class.config.key).to eq('key2')
+      expect(described_class.config.id_project).to eq('key3')
+    end
+  end
+
+  context 'unknown key' do
+    subject do
+      described_class.configure do |config|
+        config.unknown_key = 'key1'
+      end
+    end
+
+    it 'raise error' do
+      expect { subject }.to raise_error(NoMethodError)
+    end
+  end
+end

data/spec/contacts_delete_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Ofsys::Request::ContactsDelete do
+  include ConfigureHelper
+  before(:each) { configure_defaults }
+
+  let(:data) do
+    {
+      Clause: {
+        :'$type' => 'FieldClause',
+        Field: {
+          Name: 'f_EMail'
+        },
+        TypeOperator: 'Equal',
+        ComparisonValue: 'aishek@gmail.com'
+      },
+      MaxRows: 1
+    }
+  end
+
+  let(:result) do
+    {
+      'Success' => true,
+      'ErrorCode' => nil,
+      'ErrorMessage' => nil,
+      'DeletedRecords' => 1,
+      'idRequest' => 18946891,
+      'Trace' => "Beginning request (04:26:51)\r\n\tchecking OFSYS User authentication: False\r\n\tchecking Dialog Insight administrator: False\r\nTargeted service: Contacts.Delete\r\nDeserializing JSON...\r\nDeserializing JSON completed\r\nValidating parameters...\r\nValidating parameterscompleted with success\r\nExecuting method...\r\nExecuting method completed with success"
+    }
+  end
+
+  it 'performs correct request with passed data' do
+    VCR.use_cassette('contacts_delete') do
+      expect(described_class.new.perform(data)).to eq(result)
+    end
+  end
+end

data/spec/contacts_merge_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Ofsys::Request::ContactsMerge do
+  include ConfigureHelper
+  before(:each) { configure_defaults }
+
+  let(:data) do
+    {
+      Records: [
+        {
+          ID: {
+            key_f_EMail: 'aishek@gmail.com'
+          },
+          Data: {
+            f_EMail: 'aishek@gmail.com'
+          }
+        }
+      ],
+      MergeOptions: {
+        AllowInsert: true,
+        AllowUpdate: true,
+        SkipDuplicateRecords: false,
+        SkipUnmatchedRecords: false,
+        ReturnRecordsOnSuccess: false,
+        ReturnRecordsOnError: false,
+        FieldOptions: nil
+      }
+    }
+  end
+
+  let(:result) do
+    {
+      'Success' => true,
+      'ErrorCode' => nil,
+      'ErrorMessage' => nil,
+      'CreatedRecords' => 0,
+      'UpdatedRecords' => 1,
+      'Records' => [
+        {
+          'IdRecord' => 15,
+          'Status' => 'Updated',
+          'ValidationResult' => 'OK',
+          'Message' => nil,
+          'ID' => {
+            'key_f_EMail' => 'aishek@gmail.com'
+          },
+          'Data' => nil,
+          'Record' => nil
+        }
+      ],
+      'idRequest' => 18945355,
+      'Trace' => "Beginning request (04:15:25)\r\n\tchecking OFSYS User authentication: False\r\n\tchecking Dialog Insight administrator: False\r\nTargeted service: Contacts.Merge\r\nDeserializing JSON...\r\nDeserializing JSON completed\r\nValidating parameters...\r\nRecords count: 1\r\nRecords candidates for insert: 1\r\nRecords candidates for update: 1\r\nValidating parameterscompleted with success\r\nExecuting method...\r\n\tRecords bulked: 1\r\n\tRecords matched by PK: 1\r\n\tRecords dupes, source versus source: 0\r\n\tRecords dupes, source versus target: 0\r\n\tRecords updated: 1\r\n\tRecords created: 0\r\n\tEMails changed: 0\r\n\tOptins field changed: no flag involved\r\nExecuting method completed with success"
+    }
+  end
+
+  it 'performs correct request with passed data' do
+    VCR.use_cassette('contacts_merge') do
+      expect(described_class.new.perform(data)).to eq(result)
+    end
+  end
+end

data/spec/send_single_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Ofsys::Request::SendingsSendSingle do
+  include ConfigureHelper
+  before(:each) { configure_defaults }
+
+  let(:data) do
+    {
+      idMessage: 538731,
+      contactFilter: {
+        Mode: 'Clauses',
+        TableClauses: [
+          {
+            TableCode: 'Contact',
+            Clause: {
+              :'$type' => 'FieldClause',
+              Field: {
+                TableCode: 'Contact',
+                Name: 'f_EMail'
+              },
+              TypeOperator: 'Equal',
+              ComparisonValue: 'ab+45@cifronomika.ru'
+            }
+          }
+        ]
+      }
+    }
+  end
+
+  let(:result) do
+    {
+      'Success' => true,
+      'ErrorCode' => nil,
+      'ErrorMessage' => nil,
+      'AffectedContacts' => 1,
+      'idRequest' => 18947426,
+      'Trace' => "Beginning request (04:30:24)\r\n\tchecking OFSYS User authentication: False\r\n\tchecking Dialog Insight administrator: False\r\nTargeted service: Sendings.SendSingle\r\nDeserializing JSON...\r\nDeserializing JSON completed\r\nValidating parameters...\r\nValidating parameterscompleted with success\r\nExecuting method...\r\nExecuting method completed with success"
+    }
+  end
+
+  it 'performs correct request with passed data' do
+    VCR.use_cassette('sendings_send_single') do
+      expect(described_class.new.perform(data)).to eq(result)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+ENV['RAILS_ENV'] ||= 'test'
+
+require 'ofsys'
+
+require 'coveralls'
+Coveralls.wear!
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+require 'vcr'
+VCR.configure do |c|
+  c.cassette_library_dir = "#{File.dirname(__FILE__)}/fixtures/vcr_cassettes"
+  c.hook_into :webmock
+  c.allow_http_connections_when_no_cassette = true
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.order = 'random'
+end

data/spec/support/configure_helper.rb

@@ -0,0 +1,9 @@
+module ConfigureHelper
+  def configure_defaults
+    Ofsys.configure do |c|
+      c.id_key = ENV['OFSYS_ID_KEY']
+      c.key = ENV['OFSYS_KEY']
+      c.id_project = ENV['OFSYS_ID_PROJECT']
+    end
+  end
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: ofsys
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Alexandr Borisov
+- Sergey Zyablitsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ofsys.com API wrapper for Ruby language
+email:
+- aishek@gmail.com
+- sergey.zyablitsky@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- lib/ofsys.rb
+- lib/ofsys/config.rb
+- lib/ofsys/request.rb
+- lib/ofsys/request/base.rb
+- lib/ofsys/request/contacts_delete.rb
+- lib/ofsys/request/contacts_merge.rb
+- lib/ofsys/request/sendings_send_single.rb
+- lib/ofsys/version.rb
+- spec/config_spec.rb
+- spec/contacts_delete_spec.rb
+- spec/contacts_merge_spec.rb
+- spec/send_single_spec.rb
+- spec/spec_helper.rb
+- spec/support/configure_helper.rb
+homepage: https://github.com/the-furnish/ofsys
+licenses:
+- MIT
+metadata: {}
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Provides interface for ofsys.com (inteligentemails.com) service API
+test_files:
+- spec/contacts_delete_spec.rb
+- spec/config_spec.rb
+- spec/spec_helper.rb
+- spec/support/configure_helper.rb
+- spec/contacts_merge_spec.rb
+- spec/send_single_spec.rb
+has_rdoc: