remote_attr_accessor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8bafc9588ecb202ca2e69a4be628f030bfcc5e3
+  data.tar.gz: b5b7505338e24c90ce1c2261bdc4033c8b5afa47
+SHA512:
+  metadata.gz: 001e11dd3ac987ef2d6f24de6463e8da8e4b68c54c41107ee0fadd2114744694de76567f9f7e594b8c724f461ef67ab4dcd6f9d1266dfa829a0569ae7358be7e
+  data.tar.gz: 55d7c1fe45b97802231d086f6a8f7c739f0806e7347e51407aecb412448abfca6273a1b86355fa819039c7f93d099298c38913c11547c9143df8672de5c3809b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 kenji.suzuki
+
+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,88 @@
+= [Beta] RemoteAttrAccessor
+
+== Purpose
+Get remote server's attributes and set them into local attributes via API.
+
+=== For example : Micorservice's user infomation
+
+User's infomation will be used by other servers. So, prepare remote(provider) server for common user infomation provider, and Other servers(client) use 'remote_attr_accessor' to get common infomation of users.
+
+== Settings
+=== Set Config
+Make file in "lib/remote_attr_accessor/config.rb" to Overwrite for your environment.
+
+  module RemoteAttrAccessor
+    class Config
+      def self.id_name
+        'id'
+      end
+
+      def self.prefix
+        'remote_'
+      end
+
+      def self.remote_json_key
+        'users'
+      end
+
+      def self.remote_attrs
+        [:email, :last_name, :first_name]
+      end
+
+      def self.remote_attrs_with_prefix
+        @remote_attrs_with_prefix = remote_attrs.map{|attr| "#{prefix}#{attr}"}
+      end
+    end
+  end
+
+=== Set API
+Make file in "lib/remote_attr_accessor/api.rb" to Overwrite for your environments.
+
+module RemoteAttrAccessor
+  class Api
+    def self.get_remote_attrs(ids)
+      # Write here API access code
+    end
+
+    def self.upsert_remote_attr(params)
+      # Write here API access code
+    end
+  end
+end
+
+==== Response format of RemoteAttrAccessor::API.get_remote_attrs
+  {
+    "users": {
+      "1": {
+        "id": 1,
+        "email": "kenjiszk@example.com",
+        "last_name": szk,
+        "first_name": kenji,
+        "created_at": "2016-05-31T18:04:05.000Z",
+        "updated_at": "2016-06-03T05:37:51.000Z"
+      },
+      "2": {
+        "id": 2,
+        "email": "sample@example.com",
+        "last_name": ple,
+        "first_name": sam,
+        "created_at": "2016-05-31T07:51:10.000Z",
+        "updated_at": "2016-05-31T07:51:10.000Z"
+      }
+    }
+  }
+
+== How to get/set remote attribute
+Use sample for "User model".
+
+  users = User.limit(1)
+  user.first.remote_email  # Get users email from remote server
+  user.first.remote_email = 'test@example.com' # Set users email to remote server
+
+== Bulk get from remote attribute
+
+  users = User.limit(1)
+  RemoteAttrAccessor::Bulk.load_remote_attr(users) # Get users info in bulk and set instance variable
+  user.first.remote_email # Not access to remote server
+
+This project rocks and uses MIT-LICENSE.

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    = 'RemoteAttrAccessor'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/remote_attr_accessor/api.rb

@@ -0,0 +1,11 @@
+module RemoteAttrAccessor
+  # Override by lib/remote_attr_accessor/api.rb
+  class Api
+    def self.get_remote_attrs(ids)
+      {}
+    end
+
+    def self.upsert_remote_attr(params)
+    end
+  end
+end

data/lib/remote_attr_accessor/attrs.rb

@@ -0,0 +1,27 @@
+module RemoteAttrAccessor::Attrs
+  extend RemoteAttrAccessor::Base
+
+  Dir.glob("#{Dir.pwd}/lib/remote_attr_accessor/*.rb").each { |r| require r}
+
+  config.remote_attrs.each do |attr|
+    attr_with_prefix = config.prefix + attr.to_s
+    define_method(attr_with_prefix) do
+      config = RemoteAttrAccessor::Config
+      remote_id = eval(config.id_name).to_s
+      eval("@#{attr_with_prefix}") ||
+        instance_variable_set(
+          "@#{attr_with_prefix}", 
+          RemoteAttrAccessor::Api.get_remote_attrs([remote_id])[config.remote_json_key][remote_id][attr.to_s]
+        )
+    end
+
+    define_method("#{attr_with_prefix}=") do |val|
+      config = RemoteAttrAccessor::Config
+      params = Hash.new
+      params[config.id_name] = eval(config.id_name).to_s
+      params[attr.to_s] = val
+      RemoteAttrAccessor::Api.upsert_remote_attr(params)
+      instance_variable_set("@#{attr_with_prefix}", nil)
+    end
+  end
+end

data/lib/remote_attr_accessor/base.rb

@@ -0,0 +1,9 @@
+module RemoteAttrAccessor::Base
+  def config
+    RemoteAttrAccessor::Config
+  end
+
+  def api
+    RemoteAttrAccessor::Api
+  end
+end

data/lib/remote_attr_accessor/bulk.rb

@@ -0,0 +1,29 @@
+module RemoteAttrAccessor::Bulk
+  extend RemoteAttrAccessor::Base
+
+  def load_remote_attr(locals)
+    id_name = config.id_name
+    ids = Array.new
+    if locals.is_a?(ActiveRecord::Relation)
+      locals.each do |local|
+        ids << local[id_name]
+      end
+    elsif locals.is_a?(ActiveRecord::Base)
+      ids << locals[id_name]
+    end
+
+    remote_attrs_json = api.get_remote_attrs(ids)
+    return if remote_attrs_json == {}
+    remote_attrs = remote_attrs_json[config.remote_json_key]
+
+    (locals.is_a?(ActiveRecord::Relation || Array) ? locals : [locals]).each do |local|
+      ignored_attrs = [id_name.to_s, 'created_at', 'updated_at']
+      (remote_attrs[local[id_name].to_s].keys - ignored_attrs).each do |rattr|
+        attr_with_prefix = "@#{config.prefix}#{rattr}"
+        local.instance_variable_set(attr_with_prefix, remote_attrs[local[id_name].to_s][rattr.to_s])
+      end
+    end
+  end
+
+  module_function :load_remote_attr
+end

data/lib/remote_attr_accessor/config.rb

@@ -0,0 +1,24 @@
+module RemoteAttrAccessor
+  # Override by lib/remote_attr_accessor/config.rb
+  class Config
+    def self.id_name
+      'id'
+    end
+
+    def self.prefix
+      'remote_'
+    end
+
+    def self.remote_json_key
+      'users'
+    end
+
+    def self.remote_attrs
+      [:email, :last_name, :first_name]
+    end
+
+    def self.remote_attrs_with_prefix
+      @remote_attrs_with_prefix = remote_attrs.map{|attr| "#{prefix}#{attr}"}
+    end
+  end
+end

data/lib/remote_attr_accessor/version.rb

@@ -0,0 +1,3 @@
+module RemoteAttrAccessor
+  VERSION = "0.0.1"
+end

data/lib/remote_attr_accessor.rb

@@ -0,0 +1,9 @@
+module RemoteAttrAccessor
+end
+
+require_relative 'remote_attr_accessor/version'
+require_relative 'remote_attr_accessor/config'
+require_relative 'remote_attr_accessor/base'
+require_relative 'remote_attr_accessor/api'
+require_relative 'remote_attr_accessor/attrs'
+require_relative 'remote_attr_accessor/bulk'

data/lib/tasks/remote_attr_accessor_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :remote_attr_accessor do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: remote_attr_accessor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- kenji.suzuki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.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'
+description: Access to Remote Rails Model by API and set to Local Model attribute.
+email:
+- kenji.suzuki.1984@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/remote_attr_accessor.rb
+- lib/remote_attr_accessor/api.rb
+- lib/remote_attr_accessor/attrs.rb
+- lib/remote_attr_accessor/base.rb
+- lib/remote_attr_accessor/bulk.rb
+- lib/remote_attr_accessor/config.rb
+- lib/remote_attr_accessor/version.rb
+- lib/tasks/remote_attr_accessor_tasks.rake
+homepage: ''
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Remote Model Attribute Accessor.
+test_files: []