samenessed 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f5512c5b141bbeead53191a6ce18ed0f94dbd2e
+  data.tar.gz: dda13ca94010023ddaf6269777b8aa6fe25ee498
+SHA512:
+  metadata.gz: f80989e0235bc0b8994379ece180d34d0b1372ad152a464a4ae5709d03d8b0e74cba9f154623ca8d141f6a05687648a3058856273becdf805ee7d2bcbf1e827b
+  data.tar.gz: b1cdc94b7466aed57bf6dfd1e8d8908db1d8fb3eb7c9ec7405725eb3159d1e7800b35d172387aa1324e5c36b5ac36a0e442949f52e9a724f256a3f13b6d4ffed

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+config/config.yml

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in samenessed.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Julian Weber
+
+MIT License
+
+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.md

@@ -0,0 +1,79 @@
+# Samenessed
+
+The samenessed gem enables access to the sameness service ( https://github.com/avarteqgmbh/sameness ) . It provides access to the subject and principal class by connecting the sameness service's api.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'samenessed'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install samenessed
+
+## Prerequisites
+
+Ensure to call Samenessed.load_config_file(path_to_your_config_file) before issuing any functions. You can include this line in an initializer wihtin your rails application. 
+
+## Usage
+
+You can specify the SAMENESSED_ENV environment variable to select the environment for samenessed. The default is 'development'.
+
+### Subjects (Master Identities)
+
+#### Create a subject
+
+    subject = Subject.new(firstname: 'James', lastname: 'Kirk')
+    subject.new?  # => true
+    subject.save  # => true
+    subject.new   # => false
+    subject.id    # => 1
+
+#### Find subjects
+
+    subject = Subject.find(1)
+    subject.firstname   # => 'James'
+    subject.id          # => 1
+
+#### Delete a subject
+
+    subject = Subject.find(1)
+    subject.destroy   # => true
+    subject.exists?   # => false
+
+#### Update a subject
+
+    subject = Subject.find(1)
+    subject.firstname = 'Ron'
+    subject.save  # => true
+
+### Principals (Service Identities)
+
+Find, delete and update methods are correspond to the method
+descriptions above.
+
+#### Create a new Principal
+
+    subject = Subject.find(1)
+    principal = Principal.new(account_type: "jabber", name: "name@jabberhost.de", remote_id: 123, subject_id: subject.id)
+    principal.exists?	# => false
+    principal.save		# => true
+    principal.exists?	# => true
+
+
+#### Retrieve Principals of a subject
+
+    subject = Subject.find(1)
+    subject.principals
+    subject.principals.count # => 2
+
+#### Retrieve Account data from another account
+    to_account_type = "harvest"
+    from_account_type = "jabber"
+    from_account_name = "john@jabber.johndoe.com"
+    Principal.fetch_identity(from_account_type, from_account_name, to_account_type) # => "johnd@company.com"

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+desc 'Run a pry console session'
+task :console do
+  exec("pry -r ./lib/samenessed.rb")
+end
+
+task c: :console

data/config/config.yml.example

@@ -0,0 +1,9 @@
+production:
+  site: http://sameness.de.a9sapp.eu/
+  user: prod_user
+  password: prod_password
+  
+development:
+  site: http://sameness2.de.a9sapp.eu/
+  user: dev_user
+  password: dev_password

data/lib/samenessed/principal.rb

@@ -0,0 +1,29 @@
+module Samenessed
+  class Principal < ActiveResource::Base
+    self.site = Samenessed.site
+    self.user = Samenessed.user
+    self.password = Samenessed.password
+    
+    belongs_to :subject, :class_name => 'Samenessed::Subject'
+    
+    # Retrieves the target identity for the given origin data.
+    # Returns a string with the target identity or nil if no matching principal could be found
+    # Arguments:
+    # - from_account_type : The type of the origin account
+    # - from_account_name : The id of the origin account
+    # - to_account_type : The type of the target account
+    def self.fetch_identity(from_account_type, from_account_name, to_account_type)
+      raise ArgumentError, "No from account type given!" if from_account_type.nil?
+      raise ArgumentError, "No from account name given!" if from_account_name.nil?
+      raise ArgumentError, "No to account type given!" if to_account_type.nil?
+      
+      h = Principal.get(:fetch, { :from => { :account_type => from_account_type, :name => from_account_name }, :to => { :account_type => to_account_type } } )
+      
+      unless h.nil?
+        h["name"]
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/samenessed/subject.rb

@@ -0,0 +1,9 @@
+module Samenessed
+  class Subject < ActiveResource::Base
+    self.site = Samenessed.site
+    self.user = Samenessed.user
+    self.password = Samenessed.password
+    
+    has_many :principals, :class_name => 'Samenessed::Principal'
+  end
+end

data/lib/samenessed/version.rb

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

data/lib/samenessed.rb

@@ -0,0 +1,43 @@
+require "samenessed/version"
+require "active_resource"
+
+module Samenessed
+  autoload :Subject, File.expand_path('../samenessed/subject', __FILE__)
+  autoload :Principal, File.expand_path('../samenessed/principal', __FILE__)  
+  
+  @site
+  @user
+  @password
+  
+  def self.load_config_file(filepath)
+    config = YAML.load(File.read(filepath))[Samenessed.env]
+    @site = config["site"]
+    @user = config["user"]    
+    @password = config["password"]
+    return config
+  end
+
+  def self.load_config_from_hash(hash)
+    @site = hash[:site]
+    @user = hash[:user]
+    @password = hash[:password]
+    return hash
+  end
+  
+  def self.env
+    env = ENV['SAMENESSED_ENV'] || 'development'
+    env
+  end
+  
+  def self.site
+    @site
+  end
+  
+  def self.user
+    @user
+  end
+  
+  def self.password
+    @password
+  end
+end

data/samenessed.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'samenessed/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "samenessed"
+  spec.version       = Samenessed::VERSION
+  spec.authors       = ["Julian Weber"]
+  spec.email         = ["jweber@anynines.com"]
+  spec.description   = %q{Samenessed provides access to the sameness service using simple object methods.}
+  spec.summary       = %q{A sameness access gem.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-debugger"
+  
+  spec.add_dependency 'activeresource'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: samenessed
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julian Weber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: 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: pry-debugger
+  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: activeresource
+  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'
+description: Samenessed provides access to the sameness service using simple object
+  methods.
+email:
+- jweber@anynines.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/config.yml.example
+- lib/samenessed.rb
+- lib/samenessed/principal.rb
+- lib/samenessed/subject.rb
+- lib/samenessed/version.rb
+- samenessed.gemspec
+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.0.6
+signing_key: 
+specification_version: 4
+summary: A sameness access gem.
+test_files: []