global_registry_models 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e29c0de9cfad74c834e9cddc425fea1f7c0f8382
+  data.tar.gz: 47ba8ada08097a44a5f0fd68f99866bae37cf320
+SHA512:
+  metadata.gz: f01b912964d9e43f8006cd54c7f945609a9b3a28b4afcbcb002aca8b6703d47b802d1b05ecaac4aff3f5aefe2753bd4348f6211eb964f0c90607771edc613b59
+  data.tar.gz: 02a2d24e3df1c23789d9ac2e54a7bc975fa2409e6d2d3e2440cb1c12816ac1953c81eebe2a600940899851cf736c95444952c67b9a66dc6d6c0e41fa3999cf6a

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/global_registry_models-*.gem

data/.ruby-gemset

@@ -0,0 +1 @@
+global_registry_models

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Sheldon Dueck
+
+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,34 @@
+# Global Registry Models
+
+Provides data models for interacting with the [Global Registry](http://www.global-registry.org/). Built ontop of the [client gem global_registry](https://github.com/CruGlobal/global_registry_client).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'global_registry_models'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install global_registry_models
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sheldond/global_registry_models.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'global_registry_models'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+GlobalRegistry.access_token = 'set your token here'
+GlobalRegistry.base_url = 'https://stage-api.global-registry.org/'
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/global_registry_models.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'global_registry_models/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'global_registry_models'
+  spec.version       = GlobalRegistryModels::VERSION
+  spec.authors       = ['Sheldon Dueck']
+  spec.email         = ['sheldon.dueck@gmail.com']
+
+  spec.summary       = %q{Data models for the Global Registry.}
+  spec.description   = %q{Provides data models for interacting with the Global Registry. Built ontop of the client gem global_registry.}
+  spec.homepage      = 'https://github.com/sheldond/global_registry_models'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activemodel', '~> 4.2'
+  spec.add_dependency 'virtus', '~> 1.0'
+  spec.add_dependency 'global_registry', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.8'
+  spec.add_development_dependency 'webmock', '~> 1.20'
+  spec.add_development_dependency 'pry', '~> 0.10'
+end

data/lib/global_registry_models/entity/api_operations/delete.rb

@@ -0,0 +1,24 @@
+module GlobalRegistryModels
+  module Entity
+    module APIOperations
+      module Delete
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+          def delete(id)
+            GlobalRegistry::Entity.delete id
+          end
+        end
+
+        def delete
+          if id.present?
+            self.class.delete id
+          else
+            false
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/global_registry_models/entity/api_operations/finders.rb

@@ -0,0 +1,39 @@
+require 'active_support'
+require 'global_registry'
+require 'global_registry_models/retryer'
+
+module GlobalRegistryModels
+  module Entity
+    module APIOperations
+      module Finders
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+
+          def all!(filters: nil, start_page: 1, per_page: nil, order: nil, fields: nil, ruleset: nil)
+            GlobalRegistryModels::Entity::Collection.new(meta: {}, entities: []).tap do |collection|
+              page_num = start_page
+              loop do
+                sub_collection = GlobalRegistryModels::Retryer.new(RestClient::InternalServerError).try do
+                  self.search(filters: filters, page: page_num, per_page: per_page, order: order, fields: fields, ruleset: ruleset)
+                end
+                break if sub_collection.blank?
+                collection.concat sub_collection.all
+                page_num += 1
+              end
+            end
+          end
+
+          def find(id)
+            new GlobalRegistry::Entity.find(id)['entity'][name]
+          end
+
+          def page(page_number = 1)
+            search page: page_number
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/global_registry_models/entity/api_operations/search.rb

@@ -0,0 +1,37 @@
+module GlobalRegistryModels
+  module Entity
+    module APIOperations
+      module Search
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+
+          def search(filters: nil, page: nil, per_page: nil, order: nil, fields: nil, ruleset: nil)
+            params = {
+              entity_type: name,
+              page: page,
+              per_page: per_page,
+              order: order,
+              fields: fields,
+              ruleset: ruleset
+            }.delete_if { |_, v| v.blank? }
+
+            filters.try(:reject!) { |_, v| v.blank? }
+            if filters.present?
+              # We need to generate a hash like this: { 'filters[name]' => 'name query', 'filters[attribute][nested_attribute]' => 'nested_attribute query' }
+              # It just so happens we can use CGI::parse to do it.
+              filter_params_hash = CGI::parse({ filters: filters }.to_query)
+              filter_params_hash.each { |k, v| filter_params_hash[k] = v.first if v.is_a?(Array) } # CGI::parse returns values as arrays, we just want string values
+
+              params.merge! filter_params_hash
+            end
+
+            response = GlobalRegistryModels::ResponseParser.new Retryer.new(RestClient::InternalServerError).try { GlobalRegistry::Entity.get(params) }
+            Entity::Collection.new meta: response.meta, entities: response.entities
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/global_registry_models/entity/area.rb

@@ -0,0 +1,17 @@
+module GlobalRegistryModels
+  module Entity
+    class Area < Base
+      attribute :area_code, String
+      attribute :area_name, String
+      attribute :is_active, Boolean
+
+      def self.identifying_attributes
+        [:area_name, :area_code]
+      end
+
+      def to_s
+        area_name
+      end
+    end
+  end
+end

data/lib/global_registry_models/entity/base.rb

@@ -0,0 +1,73 @@
+# A base class providing CRUD for GlobalRegistry Entities.
+# API doc at https://github.com/CruGlobal/global_registry_docs/wiki/Entities
+
+require 'active_model'
+require 'virtus'
+
+module GlobalRegistryModels
+  module Entity
+    class Base
+      include ActiveModel::Model
+      include ActiveModel::Validations
+      include Virtus.model
+
+      include GlobalRegistryModels::Entity::APIOperations::Finders
+      include GlobalRegistryModels::Entity::APIOperations::Search
+      include GlobalRegistryModels::Entity::APIOperations::Delete
+
+      attribute :id, String
+      attribute :client_integration_id, String
+
+      validates_presence_of :client_integration_id
+
+      def self.title
+        name.titleize
+      end
+
+      def self.attribute_names
+        attribute_set.collect(&:name)
+      end
+
+      def self.filterable_attributes
+        attribute_names
+      end
+
+      def self.identifying_attributes
+        [:id]
+      end
+
+      def self.create(attributes)
+        attributes = attributes.except(:id)
+        if new(attributes).valid?
+          new GlobalRegistry::Entity.post({ entity: { name => attributes }})['entity'][name]
+        else
+          false
+        end
+      end
+
+      def self.update(id, attributes)
+        attributes = attributes.except(:id)
+        if new(attributes).valid?
+          new GlobalRegistry::Entity.put(id, { entity: { name => attributes }})['entity'][name]
+        else
+          false
+        end
+      end
+
+      # The name of the entity class. The entity name is required in the api responses and requests, hence the need for this class method.
+      def self.name
+        to_s.gsub(/.*::/, '').underscore
+      end
+
+      def save
+        if valid?
+          result = id.present? ? self.class.update(id, attributes) : self.class.create(attributes)
+          result ? self.id = result.id : false
+        else
+          false
+        end
+      end
+
+    end
+  end
+end

data/lib/global_registry_models/entity/collection.rb

@@ -0,0 +1,68 @@
+require 'csv'
+
+module GlobalRegistryModels
+  module Entity
+    class Collection
+      include Enumerable
+      extend Forwardable
+
+      def_delegators :@entities, :[], :size, :concat, :blank?, :present?
+
+      def initialize(meta:, entities:)
+        @meta = meta
+        @entities = entities
+      end
+
+      def each
+        @entities.each { |entity| yield entity }
+      end
+
+      def all
+        @entities
+      end
+
+      def page
+        @meta['page']
+      end
+
+      def last_page?
+        !@meta['next_page']
+      end
+
+      def first_page?
+        page == 1
+      end
+
+      def next_page
+        last_page? ? nil : page + 1
+      end
+
+      def prev_page
+        first_page? ? nil : page - 1
+      end
+
+      def from
+        @meta['from']
+      end
+
+      def to
+        @meta['to']
+      end
+
+      def per
+        (to - from) + 1
+      end
+
+      def to_csv
+        CSV.generate do |csv|
+          attributes = @entities.first.attributes.collect(&:first).sort
+          csv << attributes
+          @entities.each do |entity|
+            csv << attributes.collect { |attribute| entity.attributes[attribute] }
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/global_registry_models/entity/global_mcc.rb

@@ -0,0 +1,17 @@
+module GlobalRegistryModels
+  module Entity
+    class GlobalMcc < Base
+      attribute :mcc_code, String
+      attribute :name, String
+      attribute :partner_md_total, Integer
+
+      def self.identifying_attributes
+        [:name, :mcc_code]
+      end
+
+      def to_s
+        name
+      end
+    end
+  end
+end

data/lib/global_registry_models/entity/iso_country.rb

@@ -0,0 +1,20 @@
+module GlobalRegistryModels
+  module Entity
+    class IsoCountry < Base
+      attribute :currency_code, String
+      attribute :currency_name, String
+      attribute :currency_symbol, String
+      attribute :iso2_code, String
+      attribute :iso3_code, String
+      attribute :name, String
+
+      def self.identifying_attributes
+        [:name, :iso2_code, :iso3_code]
+      end
+
+      def to_s
+        name
+      end
+    end
+  end
+end

data/lib/global_registry_models/entity/ministry.rb

@@ -0,0 +1,23 @@
+module GlobalRegistryModels
+  module Entity
+    class Ministry < Base
+      attribute :country, String
+      attribute :city, String
+      attribute :is_active, String
+      attribute :location, String
+      attribute :min_code, String
+      attribute :name, String
+      attribute :ministry_type, String
+
+      def self.identifying_attributes
+        [:name, :country, :city, :min_code]
+      end
+
+      def to_s
+        name
+      end
+    end
+  end
+end
+
+

data/lib/global_registry_models/entity/target_area.rb

@@ -0,0 +1,46 @@
+module GlobalRegistryModels
+  module Entity
+    class TargetArea < Base
+      attribute :abbrv, String
+      attribute :address1, String
+      attribute :address2, String
+      attribute :alt_name, String
+      attribute :city, String
+      attribute :country, String
+      attribute :email, String
+      attribute :enrollment, Integer
+      attribute :event_id, Integer
+      attribute :event_type, String
+      attribute :fax, String
+      attribute :fice, String
+      attribute :gate, String
+      attribute :highest_offering, String
+      attribute :institution_type, String
+      attribute :is_closed, String
+      attribute :is_global_slm_team_target, Boolean
+      attribute :is_no_fice_ok, String
+      attribute :is_secure, Boolean
+      attribute :latitude, Float
+      attribute :longitude, Float
+      attribute :main_campus_fice, String
+      attribute :name, String
+      attribute :note, String
+      attribute :ongoing_special_event, Boolean
+      attribute :phone, String
+      attribute :region, String
+      attribute :state, String
+      attribute :target_area_ministry_presence, String
+      attribute :type, String
+      attribute :url, String
+      attribute :zip, String
+
+      def self.identifying_attributes
+        [:name, :country, :state, :state]
+      end
+
+      def to_s
+        name
+      end
+    end
+  end
+end

data/lib/global_registry_models/response_parser.rb

@@ -0,0 +1,28 @@
+module GlobalRegistryModels
+  class ResponseParser
+
+    def initialize(global_registry_response)
+      @response_hash = global_registry_response
+    end
+
+    def meta
+      @response_hash['meta']
+    end
+
+    def entities
+      @entities ||= build_entities
+    end
+
+    private
+
+      def build_entities
+        @response_hash['entities'].collect(&:flatten).collect do |entity_type, entity_attributes|
+          entity_class(entity_type).new(entity_attributes)
+        end
+      end
+
+      def entity_class(entity_type_string)
+        "GlobalRegistryModels::Entity::#{ entity_type_string.classify }".constantize
+      end
+  end
+end

data/lib/global_registry_models/retryer.rb

@@ -0,0 +1,41 @@
+module GlobalRegistryModels
+  class Retryer
+
+    attr_accessor :attempt_number, :sleepiness, :exception_classes, :max_number_of_attempts
+
+    def initialize(*exception_classes, max_attempts: 7)
+      self.attempt_number = 1
+      self.sleepiness = 0
+      self.max_number_of_attempts = max_attempts
+      self.exception_classes = exception_classes.presence || [StandardError]
+    end
+
+    def try
+      yield
+    rescue => exception
+      raise exception unless retry_exception?(exception)
+      puts "Retryer rescued #{ exception.inspect } on attempt #{ self.attempt_number }, sleeping for #{ self.sleepiness} seconds."
+      sleep sleepiness
+      increase_sleepiness
+      puts "Retryer attempting retry #{ self.attempt_number += 1 }.#{ ' This is the last attempt!' if last_attempt? }"
+      retry
+    end
+
+    private
+
+      def retry_exception?(exception)
+        exception_classes.include?(exception.class) && !last_attempt?
+      end
+
+      def last_attempt?
+        return false if max_number_of_attempts.nil?
+        attempt_number >= max_number_of_attempts
+      end
+
+      def increase_sleepiness
+        return self.sleepiness = 1 if sleepiness <= 0
+        self.sleepiness = [1000, (sleepiness * 2)].min
+      end
+
+  end
+end

data/lib/global_registry_models/version.rb

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

data/lib/global_registry_models.rb

@@ -0,0 +1,21 @@
+require 'active_support/all'
+
+require 'global_registry_models/version'
+
+require 'global_registry_models/response_parser'
+require 'global_registry_models/retryer'
+
+require 'global_registry_models/entity/api_operations/finders'
+require 'global_registry_models/entity/api_operations/search'
+require 'global_registry_models/entity/api_operations/delete'
+
+require 'global_registry_models/entity/base'
+require 'global_registry_models/entity/area'
+require 'global_registry_models/entity/collection'
+require 'global_registry_models/entity/global_mcc'
+require 'global_registry_models/entity/iso_country'
+require 'global_registry_models/entity/ministry'
+require 'global_registry_models/entity/target_area'
+
+module GlobalRegistryModels
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: global_registry_models
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sheldon Dueck
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: global_registry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Provides data models for interacting with the Global Registry. Built
+  ontop of the client gem global_registry.
+email:
+- sheldon.dueck@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- global_registry_models.gemspec
+- lib/global_registry_models.rb
+- lib/global_registry_models/entity/api_operations/delete.rb
+- lib/global_registry_models/entity/api_operations/finders.rb
+- lib/global_registry_models/entity/api_operations/search.rb
+- lib/global_registry_models/entity/area.rb
+- lib/global_registry_models/entity/base.rb
+- lib/global_registry_models/entity/collection.rb
+- lib/global_registry_models/entity/global_mcc.rb
+- lib/global_registry_models/entity/iso_country.rb
+- lib/global_registry_models/entity/ministry.rb
+- lib/global_registry_models/entity/target_area.rb
+- lib/global_registry_models/response_parser.rb
+- lib/global_registry_models/retryer.rb
+- lib/global_registry_models/version.rb
+homepage: https://github.com/sheldond/global_registry_models
+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.6
+signing_key: 
+specification_version: 4
+summary: Data models for the Global Registry.
+test_files: []