ensconce 0.0.2

data/lib/ensconce/mangle.rb

@@ -0,0 +1,31 @@
+
+module Ensconce
+  module Mangle
+    
+    # Hash#merge will replace the value of a key with its replacement's value.
+    # If the value is itself a hash, the original is replaced.
+    # With deep_merge, if the value is a hash the original value is merged with
+    # the replacements.
+    #     original    = {one: {two: 2}, three: 3}
+    #     replacement = {one: {four: 4}}
+    #     original.merge(replacement)              --> {one: {four: 4}, three: 3}
+    #     Mangle.deep_merge(original, replacement) --> {one: {two: 2, four: 4}, three: 3}
+    def self.deep_merge(original, replacement)
+      if original.kind_of? Hash
+        original.merge(replacement){|key, oldval, newval| deep_merge(oldval, newval)}
+      else
+        replacement
+      end
+    end
+    
+    # Changes the keys of a hash based on a hash. The map is a hash where the
+    # values are the old keys, and the values are the replacement keys
+    #     original = {one: {two: 2}, three: 3}
+    #     hash      = {one: :four, three: :five}
+    #     Mangle.rekey(original, hash)  -->   {four: {two: 2}, five: 3}
+    def self.rekey(hash, change_map)
+      change_map.each{|old, new| hash[new] = hash.delete(old)}
+      return hash
+    end
+  end
+end

data/lib/ensconce/version.rb

@@ -0,0 +1,15 @@
+module Ensconce
+  VERSION = "0.0.2"
+end
+
+# History
+# =======
+#
+# 0.0.2: Cleansed release
+# -----------------------
+# Re-release with settings.yml purged
+# 
+# 0.0.1: First release
+# --------------------
+# Includes YAML and MyDex adapters.
+#

data/test/data/users.yml

@@ -0,0 +1,9 @@
+user_1:
+  first_name: Bob
+  last_name: Bloggs
+  gender: Male
+  
+user_2:
+  first_name: Jane
+  last_name: Doe
+  gender: Female

data/test/ensconce/adapters/adapter_test.rb

@@ -0,0 +1,22 @@
+require 'test/unit'
+require_relative '../../../lib/ensconce'
+
+module Ensconce
+  class AdapterTest < Test::Unit::TestCase
+    def test_config
+      stuff = {foo: 'bar'}
+      Adapter.config(stuff)    
+      assert_equal(stuff, Adapter.options)
+    end
+    
+    def test_method_holders
+      methods = %w{get push}
+      adapter = Adapter.new
+      methods.each do |method|
+        assert_raise RuntimeError, "Adapter.#{method} should raise an error." do
+          adapter.send method
+        end
+      end  
+    end
+  end
+end

data/test/ensconce/adapters/mydex_adapter_test.rb

@@ -0,0 +1,49 @@
+require_relative '../../test_helper'
+
+module Ensconce
+  class MydexAdapterTest < Test::Unit::TestCase
+    def setup
+      
+      MydexAdapter.config(
+        url: settings['mydex']['url'],
+        api_key: settings['mydex']['api_key']
+      )
+    end
+    
+    def test_adapter_for
+      user = TestUser.new(
+        :key => settings['mydex']['key'], 
+        :con_id => settings['mydex']['con_id'],
+        :id => settings['mydex']['id']
+      )
+      @adapter = MydexAdapter.for(user, :data_set => 'field_ds_personal_details')
+      assert_equal(settings['mydex']['key'], @adapter.settings.key)
+    end
+
+
+    
+    def test_get
+      test_adapter_for
+      VCR.use_cassette('datastore_test_get') do
+        data = @adapter.get
+        assert_equal(MydexKeyMap.field_ds_personal_details_map[:replacement], data.keys)
+        assert(data.values.collect{|v| v unless v.empty?}.compact.length > 0, "Values should not all be empty")
+      end
+    end
+
+    def test_push
+      values = %w{Harry Mary Trevor}
+      key = 'first_name'
+      test_adapter_for
+      values.each do |value|
+        VCR.use_cassette("datastore_push_#{value}") do
+          @adapter.push({key => value})
+        end
+        VCR.use_cassette("datastore_get_#{value}") do
+          result = @adapter.get
+          assert_equal(value, result[key])
+        end      
+      end
+    end
+  end
+end

data/test/ensconce/adapters/yaml_file_adapter_test.rb

@@ -0,0 +1,31 @@
+require_relative '../../test_helper'
+
+module Ensconce
+  class YamlFileAdapterTest < Test::Unit::TestCase
+    
+    def setup
+      @users = fixture['users']
+      YamlFileAdapter.config(
+        :file => data_path('users')
+      )
+      @user = TestUser.new(:id => 'user_1')
+      @adapter = YamlFileAdapter.for(@user)
+    end
+
+    def test_setup
+      assert_equal(current_data_for('users'), @users)
+    end
+
+    def test_get
+      assert_equal(@users[@user.id], @adapter.get)
+    end
+
+    def test_push
+      update = {"first_name" => 'Harry'}
+      @adapter.push(update)
+      @users[@user.id].merge!(update)
+      assert_equal(@users, current_data_for('users'))
+    end
+
+  end
+end

data/test/ensconce/data_store_test.rb

@@ -0,0 +1,72 @@
+require_relative '../test_helper'
+
+module Ensconce
+  class DataStoreTest < Test::Unit::TestCase
+    def setup
+      DataStore.adapter = YamlFileAdapter.config(:file => data_path('users'))
+      @users = fixture['users']
+      user = TestUser.new(id: 'user_1')
+      @data_store = DataStore.open user
+    end
+    
+    def test_open
+      assert_equal(@users['user_1'], @data_store)
+    end
+    
+    def test_save
+      name = 'Gillian'
+      @data_store['first_name'] = name
+      @data_store.save
+      @users['user_1'].merge!({'first_name' => name})
+      assert_equal(@users, current_data_for('users'))
+    end
+    
+    def test_new
+      user = TestUser.new(id: 'user_99')
+      @user = {
+        user.id => {
+          'first_name' => 'Ice',
+          'last_name' => 'Cream',
+          'gender' => 'female'
+        }
+      }
+      @data_store = DataStore.new(user, :data => @user[user.id])
+      assert_equal(@user[user.id], @data_store)
+    end
+    
+    def test_create
+      test_new
+      @data_store.save
+      @users.merge! @user
+      assert_equal(@users, current_data_for('users'))
+    end
+    
+    def test_with_mydex_adapter
+      DataStore.adapter = MydexAdapter.config(        
+        url: settings['mydex']['url'],
+        api_key: settings['mydex']['api_key']
+      )
+      @user = TestUser.new(
+        :key => settings['mydex']['key'], 
+        :con_id => settings['mydex']['con_id'],
+        :id => settings['mydex']['id']
+      )
+      VCR.use_cassette('datastore_before_mydex_adapter_test') do
+        @data_store = DataStore.open(
+          @user, 
+          :data_set => 'field_ds_personal_details')
+        @name = 'Gillian'
+        @data_store['first_name'] = @name
+        @data_store.save
+      end  
+      VCR.use_cassette('datastore_after_mydex_adapter_test') do
+        result = DataStore.open(
+          @user, 
+          :data_set => 'field_ds_personal_details'
+        )
+        assert_equal(@name, result['first_name'])
+      end
+      
+    end
+  end
+end

data/test/ensconce/key_mappers/hash_builder_test.rb

@@ -0,0 +1,102 @@
+require_relative '../../test_helper'
+
+module Ensconce
+  class HashBuilderTest < Test::Unit::TestCase
+    
+    def setup
+      @words = %w{one two three}
+      @numbers = %w{1 2 3}
+      @hash_builder = HashBuilder.new(
+        :keys => @words,
+        :values => @numbers
+      )
+    end
+    
+    def test_initiation
+      assert_equal @words, @hash_builder.keys
+      assert_equal @numbers, @hash_builder.values
+    end
+    
+    def test_lack_of_keys
+      hash_builder = HashBuilder.new(:values => @numbers)
+      assert_raise RuntimeError do
+        hash_builder.hash
+      end
+    end
+    
+    def test_lack_of_values
+      hash_builder = HashBuilder.new(:keys => @numbers)
+      assert_raise RuntimeError do
+        hash_builder.hash
+      end
+    end
+    
+    def test_map
+      expected = {'one' => '1', 'two' => '2', 'three' => '3'}
+      assert_equal(expected, @hash_builder.hash)
+    end
+    
+    def test_keys_mod
+      @hash_builder.keys_mod = lambda {|element| element.upcase}
+      expected = {'ONE' => '1', 'TWO' => '2', 'THREE' => '3'}
+      assert_equal(expected, @hash_builder.hash)
+    end
+    
+    def test_keys_mod_with_invalid_input
+      @hash_builder.keys_mod = 'x'
+      assert_raise RuntimeError do
+        @hash_builder.hash
+      end 
+    end
+    
+    def test_values_mod
+      @hash_builder.values_mod = lambda {|element| (element.to_i * 2).to_s}
+      expected = {'one' => '2', 'two' => '4', 'three' => '6'}
+      assert_equal(expected, @hash_builder.hash)
+    end
+    
+    # Test added to show how procs with returns in mods can cause unexpected results
+    def test_mod_with_proc
+      @hash_builder.values_mod = Proc.new {|element| return (element.to_i * 2).to_s}
+      map = @hash_builder.hash
+      flunk "Never gets here"
+      # because return in Proc stops process and returns value to test_mod_with_proc caller
+    end
+    
+    # Demonstration that it is the return in the Proc that messes up the test.
+    # If you alter 'expected' in this test, the test will fail.
+    def test_mod_with_proc_and_no_return
+      @hash_builder.values_mod = Proc.new {|element| (element.to_i * 2).to_s}
+      expected = {'one' => '2', 'two' => '4', 'three' => '6'}
+      map = @hash_builder.hash
+      assert_equal(expected, map)
+    end
+    
+    # Test with lambda shows a more predictable result
+    def test_mod_with_lambda
+      @hash_builder.values_mod = lambda {|element| return (element.to_i * 2).to_s}
+      expected = {'one' => '2', 'two' => '4', 'three' => '6'}
+      map = @hash_builder.hash
+      assert_equal(expected, map)
+    end
+    
+    def test_mod_with_lambda_and_no_return
+      @hash_builder.values_mod = lambda {|element| (element.to_i * 2).to_s}
+      expected = {'one' => '2', 'two' => '4', 'three' => '6'}
+      map = @hash_builder.hash
+      assert_equal(expected, map)
+    end
+    
+    def test_mods_on_initiation
+      hash_builder = HashBuilder.new(
+        :keys => @words,
+        :values => @numbers,
+        :keys_mod => lambda {|element| element.reverse},
+        :values_mod => Proc.new {|element| (element.to_i + 2).to_s}
+      )
+      expected = {'eno' => '3', 'owt' => '4', 'eerht' => '5'}
+      assert_equal(expected, hash_builder.hash)
+    end
+    
+  end
+end

data/test/ensconce/key_mappers/mydex_key_map_test.rb

@@ -0,0 +1,20 @@
+require_relative '../../test_helper'
+
+module Ensconce
+  class MydexKeyMapTest < Test::Unit::TestCase
+    def test_for
+      expected = {
+        "field_personal_fname"=>"first_name", 
+        "field_personal_faname"=>"last_name", 
+        "field_personal_gender"=>"gender", 
+        "field_personal_maname"=>"maiden_name", 
+        "field_personal_mname"=>"middle_name", 
+        "field_personal_nickname"=>"nick_name", 
+        "field_personal_suffix"=>"suffix", 
+        "field_personal_title"=>"title"
+      }
+      map = MydexKeyMap.for('field_ds_personal_details')
+      assert_equal(expected, map)
+    end
+  end
+end

data/test/ensconce/mangle_test.rb

@@ -0,0 +1,25 @@
+require_relative '../test_helper'
+
+module Ensconce
+  class MangleTest < Test::Unit::TestCase
+    
+    def setup
+      @hash = {foo: {bar: 38, chew: 12}, this: 'that'}
+    end
+    
+    def test_deep_merge
+      replacement = {foo: {bar: 21}}
+      expected = {foo: {bar: 21, chew: 12}, this: 'that'}
+      assert_equal(expected, Mangle.deep_merge(@hash, replacement))
+    end
+    
+    def test_rekey
+      map = {
+        foo: :changed_foo,
+        this: :changed_this
+      }
+      expected = {changed_foo: {bar: 38, chew: 12}, changed_this: 'that'}
+      assert_equal(expected, Mangle.rekey(@hash, map))
+    end
+  end
+end

data/test/fixtures/users.yml

@@ -0,0 +1,9 @@
+user_1:
+  first_name: Bob
+  last_name: Bloggs
+  gender: Male
+  
+user_2:
+  first_name: Jane
+  last_name: Doe
+  gender: Female

data/test/fixtures/vcr_cassettes/datastore_after_mydex_adapter_test.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://sbx-api.mydex.org/api/pds/pds/93.json?api_key=rN31O75AWviNYezE2vWsMDP6kS88Zc5P&con_id=93-1545&data_set=field_ds_personal_details&dataset=field_ds_personal_details&key=LlPwdnq38tMtCPP7u60HjTYy35MxAVkf&source_type=connection
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.6
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 17 Mar 2014 14:20:21 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Expires:
+      - Sun, 19 Nov 1978 05:00:00 GMT
+      Last-Modified:
+      - Mon, 17 Mar 2014 14:20:21 +0000
+      Cache-Control:
+      - no-cache, must-revalidate, post-check=0, pre-check=0
+      Etag:
+      - ! '"1395066021"'
+    body:
+      encoding: US-ASCII
+      string: ! '{"field_ds_personal_details":{"instance_0":{"field_personal_faname":{"value":"","access":{"r":{"a":"1","s":"A"},"w":{"a":"1","s":"A"}}},"field_personal_fname":{"value":"Gillian","access":{"r":{"a":"1","s":"A"},"w":{"a":"1","s":"A"}}},"field_personal_gender":{"value":"","access":{"r":{"a":"1","s":"A"},"w":{"a":"1","s":"A"}}},"field_personal_maname":{"value":"","access":{"r":{"a":"1","s":"A"},"w":{"a":"1","s":"A"}}},"field_personal_mname":{"value":"","access":{"r":{"a":"1","s":"A"},"w":{"a":"1","s":"A"}}},"field_personal_nickname":{"value":"","access":{"r":{"a":"1","s":"A"},"w":{"a":"1","s":"A"}}},"field_personal_suffix":{"value":"","access":{"r":{"a":"1","s":"A"},"w":{"a":"1","s":"A"}}},"field_personal_title":{"value":"","access":{"r":{"a":"1","s":"A"},"w":{"a":"1","s":"A"}}}}}}'
+    http_version: 
+  recorded_at: Mon, 17 Mar 2014 14:20:27 GMT
+recorded_with: VCR 2.4.0

data/test/fixtures/vcr_cassettes/datastore_before_mydex_adapter_test.yml

@@ -0,0 +1,85 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://sbx-api.mydex.org/api/pds/pds/93.json?api_key=rN31O75AWviNYezE2vWsMDP6kS88Zc5P&con_id=93-1545&data_set=field_ds_personal_details&dataset=field_ds_personal_details&key=LlPwdnq38tMtCPP7u60HjTYy35MxAVkf&source_type=connection
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.6
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 17 Mar 2014 14:20:20 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Expires:
+      - Sun, 19 Nov 1978 05:00:00 GMT
+      Last-Modified:
+      - Mon, 17 Mar 2014 14:20:20 +0000
+      Cache-Control:
+      - no-cache, must-revalidate, post-check=0, pre-check=0
+      Etag:
+      - ! '"1395066020"'
+    body:
+      encoding: US-ASCII
+      string: ! '{"field_ds_personal_details":{"instance_0":{"field_personal_faname":{"value":"","access":{"r":{"a":"1","s":"A"},"w":{"a":"1","s":"A"}}},"field_personal_fname":{"value":"Trevor","access":{"r":{"a":"1","s":"A"},"w":{"a":"1","s":"A"}}},"field_personal_gender":{"value":"","access":{"r":{"a":"1","s":"A"},"w":{"a":"1","s":"A"}}},"field_personal_maname":{"value":"","access":{"r":{"a":"1","s":"A"},"w":{"a":"1","s":"A"}}},"field_personal_mname":{"value":"","access":{"r":{"a":"1","s":"A"},"w":{"a":"1","s":"A"}}},"field_personal_nickname":{"value":"","access":{"r":{"a":"1","s":"A"},"w":{"a":"1","s":"A"}}},"field_personal_suffix":{"value":"","access":{"r":{"a":"1","s":"A"},"w":{"a":"1","s":"A"}}},"field_personal_title":{"value":"","access":{"r":{"a":"1","s":"A"},"w":{"a":"1","s":"A"}}}}}}'
+    http_version: 
+  recorded_at: Mon, 17 Mar 2014 14:20:26 GMT
+- request:
+    method: put
+    uri: https://sbx-api.mydex.org/api/pds/pds/93.json?api_key=rN31O75AWviNYezE2vWsMDP6kS88Zc5P&con_id=93-1545&data_set=field_ds_personal_details&key=LlPwdnq38tMtCPP7u60HjTYy35MxAVkf&source_type=connection
+    body:
+      encoding: UTF-8
+      string: ! '{"field_ds_personal_details":[{"field_personal_fname":"Gillian","field_personal_faname":"","field_personal_gender":"","field_personal_maname":"","field_personal_mname":"","field_personal_nickname":"","field_personal_suffix":"","field_personal_title":""}]}'
+    headers:
+      User-Agent:
+      - Faraday v0.8.6
+      Content-Type:
+      - application/json
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 17 Mar 2014 14:20:21 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Expires:
+      - Sun, 19 Nov 1978 05:00:00 GMT
+      Last-Modified:
+      - Mon, 17 Mar 2014 14:20:21 +0000
+      Cache-Control:
+      - no-cache, must-revalidate, post-check=0, pre-check=0
+      Etag:
+      - ! '"1395066021"'
+    body:
+      encoding: US-ASCII
+      string: ! '{"success":1,"data":{"field_ds_personal_details":[{"field_personal_fname":"Gillian","field_personal_faname":"","field_personal_gender":"","field_personal_maname":"","field_personal_mname":"","field_personal_nickname":"","field_personal_suffix":"","field_personal_title":""}]}}'
+    http_version: 
+  recorded_at: Mon, 17 Mar 2014 14:20:26 GMT
+recorded_with: VCR 2.4.0