ensconce 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NWI1MTk3MjlkYzg1ODNmMGFlMWFmNzUwODA0MjVmZWVjNjlhMWJjMQ==
+  data.tar.gz: !binary |-
+    MTQwODNjZTU5OThlOWI4OTY0MzAwMjMyNmNjZTNjMmE0OTlmMTIwOQ==
+SHA512:
+  metadata.gz: !binary |-
+    MjJkYTU3NzkzOTU2ODRkN2U0NDc0YzM0MmQyM2MyOGY3OWIzOThmOWNmOTc5
+    MWI4ZjE4MGQwZjMwODE2OTk5MjRhNzhjZGY3NGJkZGViZGMyNWMyNWZjNTdj
+    ZTQyMDc0OTk2ZWY0NzRiMWVhNjE5NmVjNDBjOTg5ZTk0M2NjMGU=
+  data.tar.gz: !binary |-
+    OGU3ZjY0NjU2Y2NjNWViN2UwOGQ2NWY5MWUzZWExZGYxMTVhOGJjYzg5ZGY0
+    MDI2N2M4NmJjOGI3MGM0NmEwNzVlM2Q1NDVhNzgxMDM5NWY4NmY0MDM4ZjE5
+    MDEzY2U0NjVmZTY1YzhlZjVmYjVhNGFlODNhMzIzODMzOTkyNjU=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Rob Nichols
+
+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.rdoc

@@ -0,0 +1,69 @@
+== ensconce
+
+Ensconce provides a common interface to data stores. The connection between
+Ensconce::DataStore and a data store provider is configured via an adapter
+
+=== YAML file data store
+
+    user = User.new(:id => 'user_1')
+    DataStore.adapter = YamlFileAdapter.config(:file => 'path/to/file.yml')
+    data_store = DataStore.open user
+
+Opens a data store from the file specified within the adapter config. The store
+could look something like this:
+
+    user_1:
+      some_field: x
+
+We can get and set 'some_field' like this
+
+    data_store['some_field'] == 'x'   # returns true
+    data_store['some_field'] = 'y'
+    data_store.save
+
+The file will then look like this:
+
+    user_1:
+      some_field: y
+
+=== Mydex data source
+
+    DataStore.adapter = MydexAdapter.config(
+      url: <mydex url>
+      api_key: <your api key>
+    )
+
+    user = MydexUser.new(
+      key: <from your user's connection settings>
+      con_id: <from your user's connection settings>
+      id: <from your user's connection settings>
+    )
+
+We can then get the mydex user's data like this:
+
+  data_store = DataStore.open(user, :data_set => 'field_ds_personal_details')
+  data_store['first_name'] --> Mydex user's first name
+
+Updating data works just as it does for the YAML example:
+
+  data_store['first_name'] = 'Robert'
+  data_store.save
+
+This will write a new first name to the Mydex user's personal_details.
+
+=== Key mappers
+Note that in Mydex the first name field is actually 'field_personal_fname'. 
+Ensconce provides key mappers that allow you to use more generic names for 
+fields, thereby making it easier to swap data stores.
+
+== Testing ensconce
+
+To test this applications mydex connection, a settings.yml needs to be added at
+the root of the ensconce code. This file should have this format:
+
+mydex:
+  url: 'https://sbx-api.mydex.org/'
+  key: <key from sandbox connection>
+  api_key: <your mydex api key>
+  con_id: <con_id from sandbox connection>
+  id: id <from sandbox connection>

data/Rakefile

@@ -0,0 +1,9 @@
+
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*.rb']
+end

data/lib/ensconce.rb

@@ -0,0 +1,10 @@
+# load order specific files
+require_relative 'ensconce/adapters/adapter'
+require_relative 'ensconce/key_mappers/key_map'
+
+# load everything else
+Dir[File.dirname(__FILE__) + "/ensconce/**/*.rb"].each{|file| require file}
+
+module Ensconce
+   
+end

data/lib/ensconce/adapters/adapter.rb

@@ -0,0 +1,52 @@
+module Ensconce
+  
+  # Parent class for adapters. 
+  # 
+  # Specific adapters should inherit from this class
+  class Adapter
+    attr_reader :settings, :params
+    
+    def initialize(args = {})
+      @settings = args[:settings]
+      @params = args[:params]
+    end
+    
+    def self.config(options = {})
+      @options = options
+      return self
+    end
+    
+    # The object passed to for should have methods that return the settings
+    # for each instance connection. For example, a user object with an id used
+    # to retrieve data for that user.
+    def self.for(settings_object, params = {})
+      new(:settings => settings_object, :params => params)
+    end
+
+    def self.options
+      @options || {}
+    end
+
+    def self.options=(data)
+      @options = data
+    end
+    
+    def options
+      self.class.options
+    end
+    
+    def get(*args)
+      raise_define_method_error('get')
+    end
+    
+    def push(*args)
+      raise_define_method_error('push')
+    end
+    
+    
+    private
+    def raise_define_method_error(name)
+      raise "Adapter instance method '#{name}' needs to be defined"
+    end
+  end
+end

data/lib/ensconce/adapters/mydex_adapter.rb

@@ -0,0 +1,75 @@
+require 'faraday'
+require 'json'
+
+module Ensconce
+
+  class MydexAdapter < Adapter
+    
+    def get
+      @data_set = params[:data_set]
+      response = connection.get(
+        path,
+        params.merge({ dataset: @data_set })
+      )
+      @data = JSON.parse response.body
+      @data = @data[@data_set]['instance_0']
+      change_data_keys_to_data_store_names
+      extact_values
+    end
+    
+    def push(data)
+      @data_set = params[:data_set]
+      @data = data
+      change_data_keys_to_mydex_names
+      response = connection.put do |req|
+        req.url path
+        req.headers['Content-Type'] = 'application/json'
+        req.body = {@data_set => [@data]}.to_json
+        req.params = params
+      end
+      response.body
+    end
+    
+    def connection
+      Faraday.new(:url => options[:url]) do |faraday|
+        faraday.request  :url_encoded             # form-encode POST params
+#        faraday.response :logger                  # log requests to STDOUT
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end      
+    end
+    
+    def params
+      super.merge(
+        key: settings.key,
+        api_key: options[:api_key],
+        con_id: settings.con_id,
+        source_type: 'connection' 
+      )
+    end
+
+    def path
+      "api/pds/pds/#{settings.id}.json"
+    end
+    
+    def change_data_keys_to_data_store_names
+      @data = Mangle.rekey(@data, key_map(@data_set))
+    end
+    
+    def change_data_keys_to_mydex_names
+      @data = Mangle.rekey(@data, key_map(@data_set).invert)
+    end
+    
+    def extact_values
+      HashBuilder.new(
+        keys: @data.keys, 
+        values: @data.values,
+        values_mod: lambda {|value| value['value']}
+      ).hash
+    end
+    
+    def key_map(key)
+      MydexKeyMap.for(key)
+    end
+  end
+  
+end

data/lib/ensconce/adapters/yaml_file_adapter.rb

@@ -0,0 +1,21 @@
+module Ensconce
+  class YamlFileAdapter < Adapter
+    
+    def self.all
+      YAML.load_file options[:file]
+    end
+
+    def get
+      raise "No file defined" unless options[:file]
+      data = YAML.load_file options[:file]
+      data[settings.id]
+    end
+
+    def push(data)
+      result = Mangle.deep_merge self.class.all, {settings.id => data}
+      File.open(options[:file], 'w+') {|f| f.write(result.to_yaml) }
+    end
+    
+
+  end
+end

data/lib/ensconce/data_store.rb

@@ -0,0 +1,41 @@
+
+class DataStore < Hash
+  attr_accessor :settings, :params
+  
+  def initialize(settings_object, params = {})
+    super()
+    data = params.delete(:data)
+    @params = params
+    @settings = settings_object
+    replace data if data
+  end
+  
+  def save
+    raise "adapter must be specifed" unless adapter
+    adapter.push({}.merge(self))
+  end
+  
+  def adapter
+    @adapter ||= self.class.adapter.for(settings, params)
+  end
+  
+  def get
+    replace adapter.get.merge(self)
+  end
+  
+  
+  def self.open(settings_object, params = {})
+    data_store = new settings_object, params
+    data_store.get
+    return data_store
+  end
+  
+  def self.adapter=(klass)
+    @adapter_klass = klass
+  end
+  
+  def self.adapter
+    @adapter_klass
+  end
+  
+end

data/lib/ensconce/hash_builder.rb

@@ -0,0 +1,72 @@
+module Ensconce
+  
+  # Used to convert pairs of arrays into a hash.
+  # 
+  #     hash_builder = HashBuilder.new :keys => ['a', 'b'], :values => ['1', '2']
+  #     hash_builder.hash   --> {'a' => '1', 'b' => '2'}
+  #     
+  # Also allows modification of keys or values
+  # 
+  #    hash_builder.keys_mod = lambda {|key| key.upcase}
+  #    hash_builder.hash   --> {'A' => '1', 'B' => '2'}
+  #    
+  #    hash_builder.values_mod = lambda {|value| (value.to_i * 4).to_s}
+  #    hash_builder.hash   --> {'A' => '4', 'B' => '8'}
+  #    
+  # You can use a Proc to define a mod, but I'd recommend not doing so as a
+  # return statement in the Proc can cause an unexpected result (see tests).
+  #
+  class HashBuilder
+    
+    attr_accessor :keys, :values, :keys_mod, :values_mod
+    
+    def initialize(args = {})
+      @keys = args[:keys]
+      @values = args[:values]
+      @keys_mod = args[:keys_mod]
+      @values_mod = args[:values_mod]
+    end
+    
+    def valid?
+      check_required_attributes_present
+      check_mods_are_valid
+    end
+    
+    def hash
+      valid?
+      map = [processed_keys, processed_values].transpose
+      Hash[map]
+    end
+    
+    def check_mods_are_valid
+      mod_attributes.each do |mod|
+        mod = send mod
+        next unless mod
+        raise ":#{mod} must be a Proc or lambda" unless mod.kind_of? Proc
+      end
+    end
+    
+    def check_required_attributes_present
+      required_attibutes.each do |attribute|
+        raise ":#{attribute} is a required attribute but was not found" unless send(attribute)
+      end
+    end
+    
+    def required_attibutes
+      [:keys, :values]
+    end
+    
+    def mod_attributes
+      [:keys_mod, :values_mod]
+    end
+    
+    def processed_keys
+      keys_mod ? keys.collect(&keys_mod) : keys
+    end
+    
+    def processed_values
+      values_mod ? values.collect(&values_mod) : values
+    end
+  end
+ 
+end

data/lib/ensconce/key_mappers/key_map.rb

@@ -0,0 +1,35 @@
+module Ensconce
+  
+  # Parent class for key maps. 
+  # 
+  # Specific key maps should inherit from this class
+  class KeyMap
+      
+    def self.for(key)
+      key_map = new 
+      key_map[key]
+    end
+    
+    def mappings
+      @mappings ||= default_mappings
+    end
+    
+    def [](key)
+      mappings[key]
+    end
+    
+    def map_generator(args)
+      HashBuilder.new(
+        :keys => (args[:original] || args[:keys]),
+        :values => (args[:replacement] || args[:values]),
+        :keys_mod => (args[:original_mod] || args[:keys_mod]),
+        :values_mod => (args[:replacement_mod] || args[:values_mod])
+      ).hash
+    end
+    
+    def default_mapping
+      raise "default_mapping must be defined"
+    end
+    
+  end
+end

data/lib/ensconce/key_mappers/mydex_key_map.rb

@@ -0,0 +1,23 @@
+module Ensconce
+  class MydexKeyMap < KeyMap
+        
+    def default_mappings
+      {
+        'field_ds_personal_details' => field_ds_personal_details
+      }
+    end
+    
+    def field_ds_personal_details
+      map_generator( self.class.field_ds_personal_details_map )
+    end
+    
+    def self.field_ds_personal_details_map
+      {
+        :original =>    %w{fname      faname    gender maname      mname       nickname  suffix title},
+        :replacement => %w{first_name last_name gender maiden_name middle_name nick_name suffix title},
+        :original_mod => lambda {|field| "field_personal_#{field}"}        
+      }
+    end
+      
+  end
+end