stitch_data 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b9d6b674966e5a8c42715ad952b620a63775e5f
+  data.tar.gz: ebc36c487b1598138b3850485ef432ec83ffc911
+SHA512:
+  metadata.gz: a7532a43feceff09cb0117b6f8bd016c364c9d02c85404f58a3b68e3a8e33f5c1109ead228b4a924b783db7ff7e7b8cb946ee37f1f7f86765665da651e98dfa5
+  data.tar.gz: 2841465f8ac9f1a8ee34d67d5e83bd184ac6d0b7b97508ce76a60801c2e79e5601061f84e89c41da1c810c8240333db09e3365cdca3ab98b59e47e1bdfd2179b

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/stitch_data/api.rb

@@ -0,0 +1,50 @@
+module StitchData
+  class Api
+    attr_accessor :table_name, :sequence, :key_names, :data
+    API_BASE_URL = 'https://api.stitchdata.com/v2/import'.freeze
+    DEFAULT_API_ACTION = "upsert".freeze
+    DEFAULT_REQUEST_PARAMS = { content_type: 'application/json', accept: 'json' }.freeze
+
+    def initialize(table_name, sequence, key_names, data)
+      validate_key_names_is_array(key_names)
+      @request_params = { Authorization: "Bearer #{StitchData.configuration.token}" }.merge(DEFAULT_REQUEST_PARAMS)
+      @table_name = table_name.to_s
+      @sequence = sequence.to_sym
+      @key_names = key_names.map(&:to_s)
+      @data = build_records(data)
+    end
+
+    def upsert!
+      stitch_post_request("#{API_BASE_URL}/push")
+    end
+
+    def validate!
+      stitch_post_request("#{API_BASE_URL}/validate")
+    end
+
+    private
+
+    def build_records(records)
+      records.map do |record|
+        {
+          client_id: StitchData.configuration.client_id,
+          table_name: table_name,
+          sequence: record[sequence].to_i,
+          action: DEFAULT_API_ACTION,
+          key_names: key_names,
+          data: record
+        }
+      end
+    end
+
+    def validate_key_names_is_array(key_names)
+      raise StitchData::Errors::WrongUpsertFields, 'key_names field must be an Array' unless key_names.is_a?(Array)
+    end
+
+    def stitch_post_request(url)
+      JSON.parse(RestClient.post(url, @data.to_json, @request_params))
+    rescue RestClient::ExceptionWithResponse => e
+      { 'status' => e.message, 'message' => JSON.parse(e.response)['errors'] }
+    end
+  end
+end

data/lib/stitch_data/errors.rb

@@ -0,0 +1,6 @@
+module StitchData
+  module Errors
+    class WrongUpsertFields < StandardError
+    end
+  end
+end

data/lib/stitch_data/version.rb

@@ -0,0 +1,3 @@
+module StitchData
+  VERSION = "0.1.0"
+end

data/lib/stitch_data.rb

@@ -0,0 +1,24 @@
+require 'json'
+require 'rest-client'
+require 'stitch_data/api'
+require 'stitch_data/errors'
+module StitchData
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration) if block_given?
+  end
+
+  # Main configuration class.
+  class Configuration
+    attr_accessor :token, :client_id
+
+    def initialize
+      @token = nil
+      @client_id = nil
+    end
+  end
+end

data/spec/lib/stitch_data/stitch_data_spec.rb

@@ -0,0 +1,72 @@
+require 'rspec'
+require 'spec_helper'
+
+RSpec.describe 'StitchData' do
+  before :each do
+    mocked_time = Time.new
+    @first_record = { id: '1234', event_name: 'logged_in', created_at: mocked_time }
+    @second_record = { id: '12345', event_name: 'logged_out', created_at: mocked_time }
+    @data = [@first_record, @second_record]
+    @sequence = :created_at
+    @table_name = 'events'
+    @key_names = [:id]
+  end
+
+  describe :initalize do
+
+    it 'should validate upsert field key_name is of Array data type' do
+      expect { StitchData::Api.new(@table_name, @sequence, :id, @data) }
+      .to raise_error(StitchData::Errors::WrongUpsertFields)
+    end
+
+    it 'should build valid data structue' do
+      stitch_data = StitchData::Api.new(@table_name, @sequence, @key_names, @data)
+      expect(stitch_data.data).to eq(
+                                      [
+                                        {
+                                          client_id: StitchData.configuration.client_id,
+                                          table_name: @table_name,
+                                          sequence:  @first_record[@sequence].to_i,
+                                          action: StitchData::Api::DEFAULT_API_ACTION,
+                                          key_names:  @key_names.map(&:to_s),
+                                          data: @first_record
+                                        },
+                                        {
+                                          client_id: StitchData.configuration.client_id,
+                                          table_name: @table_name,
+                                          sequence: @second_record[@sequence].to_i,
+                                          action: StitchData::Api::DEFAULT_API_ACTION,
+                                          key_names: @key_names.map(&:to_s),
+                                          data: @second_record
+                                        }
+                                      ]
+                                    )
+    end
+  end
+  describe :stitch_post_request do
+    context :succesful_request do
+      before :each do
+        stub_request(:post, "https://api.stitchdata.com/v2/import/validate")
+        .to_return(status: 200, body: { status: "OK", message: "Valid" }.to_json)
+      end
+
+      it 'should return a hash with status and message' do
+        expect(StitchData::Api.new(@table_name, @sequence, @key_names, @data).validate!)
+        .to eq("status" => "OK", "message" => "Valid")
+      end
+    end
+    context :failed_request do
+      before :each do
+        stub_request(:post, "https://api.stitchdata.com/v2/import/validate")
+        .to_return(status: 403, body: '{ "status":"ERROR","errors":"An array of records is expected" }')
+      end
+
+      it 'should return hash with status and message' do
+        expect(StitchData::Api.new(@table_name, @sequence, @key_names, @data).validate!)
+        .to eq("status" => "403 Forbidden", "message" => "An array of records is expected")
+      end
+
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require "bundler/setup"
+require "pry"
+require 'json'
+require 'webmock/rspec'
+require './lib/stitch_data/api'
+require './lib/stitch_data'
+
+RSpec.configure do |config|
+  config.disable_monkey_patching!
+  config.formatter = "documentation"
+  config.color = true
+end
+
+require 'simplecov'
+
+# save to CircleCI's artifacts directory if we're on CircleCI
+if ENV['CIRCLE_ARTIFACTS']
+  dir = File.join(ENV['CIRCLE_ARTIFACTS'], "coverage")
+  SimpleCov.coverage_dir(dir)
+end
+
+SimpleCov.start

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: stitch_data
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Omri Shuva
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.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: pry
+  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: codeclimate-test-reporter
+  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: simplecov
+  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: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: Wraper for the upsert method used for import data into stitch
+email: omri@tailorbrands.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- lib/stitch_data.rb
+- lib/stitch_data/api.rb
+- lib/stitch_data/errors.rb
+- lib/stitch_data/version.rb
+- spec/lib/stitch_data/stitch_data_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/TailorBrands/stitch_data
+licenses: []
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Ruby wraper for the Stitch Data Api
+test_files:
+- spec/lib/stitch_data/stitch_data_spec.rb
+- spec/spec_helper.rb