gram_v1_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53c450edb7a70a6e8b710ac4720b3d9f6b08de05
+  data.tar.gz: 93196cffe6b60ad1865406aa8864bb203bf60825
+SHA512:
+  metadata.gz: c2771ad464bb0e936ed7eb9125b671f68f928306be0032f25d7d128d2d66691a26e9d7148eaa34d96ce2d618b5804b5087821081dd2a80d0b42d0db119663a63
+  data.tar.gz: 76a37475fa62e260874b664213191c66a702525a32d6554c2f2ed69afcc11d056efe46b0917a6e10e8ff7b136cbed67e2d6a3092d1c9be62e849813187f7edbe

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alexandre Narbonne
+
+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,116 @@
+# GramV1Client
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gram_v1_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gram_v1_client
+
+## Setup
+  
+  Before being used GramV1Client must be configured. In Rails app, put it in an Initializer.
+
+```ruby
+GramV1Client.configure do |c|
+   # Base URI used to access GrAM API
+   c.site="http://my_site.org/api/v1/"
+   # Username provided by Gadz.org
+   c.user="my_user"
+   # Password provided by Gadz.org
+   c.password="my_password"
+   # If your app use a proxy to access net, put it here
+   #c.proxy="my_proxy"
+ end
+```
+## Usage
+
+This client client is based on the active_ressource gem. [Read its documentation](https://github.com/rails/activeresource) for informations about interacting with ressources
+It provides access to the following resources on GrAM API :
+
+ - Account
+ - Profile
+ - Email
+ - Search
+
+###Account
+####Find
+```ruby
+account = GramV1Client::Account.find("john.doe.ext")
+puts account.firstname
+puts account.lastname
+#=> John
+#=> Doe
+```
+####Update
+```ruby
+account = GramV1Client::Account.find("john.doe.ext")
+account.firstname = "Johny"
+account.save
+```
+
+####Create
+```ruby
+account = GramV1Client::Account.new(hruid: "john.doe.ext", firstname: "John", lastname: "Doe")
+account.save
+```
+Or
+```ruby
+account = GramV1Client::Account.create(hruid: "john.doe.ext", firstname: "John", lastname: "Doe")
+```
+
+###Profile
+####Find
+```ruby
+profile = GramV1Client::Profile.find("john.doe.ext")
+puts account.firstname
+puts account.lastname
+#=> John
+#=> Doe
+```
+
+###Email
+####Find
+```ruby
+email = GramV1Client::Email.find("john.doe@gadz.org")
+```
+
+###Search
+This resource is used to search for accounts
+
+You can use the generic search
+```ruby
+account = GramV1Client::Search.where(:idSoce => "84185")
+```
+
+Or you can use helper methods :
+```ruby
+account = GramV1Client::Search.search_by_hruid("john.doe.ext")
+account = GramV1Client::Search.search_by_id_soce("84185")
+account = GramV1Client::Search.search_by_email("john.doe@gadz.org")
+account = GramV1Client::Search.search_by_alias("john.doe")
+```
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/Zooip/gram_v1_client.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gram_v1_client"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

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

data/gram_v1_client.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gram_v1_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gram_v1_client"
+  spec.version       = GramV1Client::VERSION
+  spec.authors       = ["Alexandre Narbonne"]
+  spec.email         = ["alexandre.narbonne@gadz.org"]
+
+  spec.summary       = "Ruby client for the Gadz.org API GrAMv1"
+  spec.homepage      = "https://github.com/Zooip/gram_v1_client"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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 'activeresource', "~> 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/gram_v1_client.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+require 'gram_v1_client/configuration'
+require 'gram_v1_client/json_formater'
+require 'gram_v1_client/base'
+require 'gram_v1_client/account'
+require 'gram_v1_client/profile'
+#require 'gram_v1_client/email'
+require 'gram_v1_client/search'
+require 'gram_v1_client/version'
+
+class GramV1Client
+end

data/lib/gram_v1_client/account.rb

@@ -0,0 +1,28 @@
+#/lib/GramAccount.rb
+#!/bin/env ruby
+# encoding: utf-8
+
+# exemple de recherche par hruid
+# GramAccount.find("alexandra.narbonnette.ext")
+
+require 'active_resource'
+require 'gram_v1_client/base'
+class GramV1Client::Account < GramV1Client::Base
+  self.element_name = "accounts"
+
+  ##
+  #Overwrite find_single from ActiveResource::Base to be able to use gram api (/accounts suffix)
+  #https://github.com/rails/activeresource/blob/master/lib/active_resource/base.rb#L991
+  def self.element_path(id, prefix_options = {}, query_options = nil)
+     id += "/accounts"
+     super(id, prefix_options, query_options)
+  end
+
+  ##
+  #Overwrite to_param from ActiveResource::Base to be able to use gram api (id = hruid)
+  #https://github.com/rails/activeresource/blob/master/lib/active_resource/base.rb#L991
+  def to_param
+    self.hruid
+  end
+
+end

data/lib/gram_v1_client/base.rb

@@ -0,0 +1,57 @@
+#/lib/GramAccount.rb
+#!/bin/env ruby
+# encoding: utf-8
+
+
+require 'active_resource'
+class GramV1Client::Base < ActiveResource::Base
+
+  # This is set to enable Configuration change at runtime.
+
+   class << self
+    def site
+      if GramV1Client.configuration.site
+        if super.to_s != URI.parse(GramV1Client.configuration.site).to_s
+          reload_config
+        end
+      end
+      super
+    end
+
+    def user()
+      if GramV1Client.configuration.user
+        if super.to_s != GramV1Client.configuration.user
+          reload_config
+        end
+      end
+      super
+    end
+
+    def password() 
+      if GramV1Client.configuration.password
+        if super.to_s != GramV1Client.configuration.password
+          reload_config
+        end
+      end
+      super
+    end
+
+    def proxy() 
+      if GramV1Client.configuration.proxy
+        if super.to_s != URI.parse(GramV1Client.configuration.proxy).to_s
+          reload_config
+        end
+      end
+      super
+    end
+
+
+    def reload_config
+      self.site= GramV1Client.configuration.site
+      self.user= GramV1Client.configuration.user 
+      self.password=GramV1Client.configuration.password 
+      self.proxy=GramV1Client.configuration.proxy
+    end
+  end
+
+end

data/lib/gram_v1_client/configuration.rb

@@ -0,0 +1,28 @@
+class GramV1Client
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+
+    def configure
+      yield(configuration)
+    end
+  end
+
+  class Configuration
+    attr_accessor :site,
+                  :user,
+                  :password,
+                  :proxy
+
+    def initialize
+      @site      = nil
+      @user      = nil
+      @password  = nil
+      @proxy     = nil
+    end
+  end
+end

data/lib/gram_v1_client/email.rb

@@ -0,0 +1,34 @@
+#/lib/GramAccount.rb
+#!/bin/env ruby
+# encoding: utf-8
+
+
+# exemple de recherche par email
+# GramEmail.find("monEmail@gadz.org")
+
+require 'active_resource'
+class GramV1Client::Email < GramV1Client::Base
+  self.element_name = "emails"
+  self.collection_name = "emails"
+  self.format = GramV1Client::JsonFormatter.new(self.collection_name)
+
+
+  #Overwrite find_single from ActiveResource::Base to be able to use gram api (/accounts suffix)
+  #https://github.com/rails/activeresource/blob/master/lib/active_resource/base.rb#L991
+  def self.element_path(id, prefix_options = {}, query_options = nil)
+     id += "/accounts"
+     super(id, prefix_options, query_options)
+  end
+
+  def collection_path(prefix_options = {}, query_options = nil)
+    id += "/accounts"
+    super(id, prefix_options, query_options)
+  end
+
+  #Overwrite to_param from ActiveResource::Base to be able to use gram api (id = hruid)
+  #https://github.com/rails/activeresource/blob/master/lib/active_resource/base.rb#L991
+  def to_param
+    self.hruid
+  end
+
+end

data/lib/gram_v1_client/json_formater.rb

@@ -0,0 +1,25 @@
+require 'active_resource'
+
+class GramV1Client::JsonFormatter
+  include ActiveResource::Formats::JsonFormat
+
+  attr_reader :collection_name
+
+  def initialize(collection_name)
+    @collection_name = collection_name.to_s
+  end
+
+  def decode(json)
+    remove_root(ActiveSupport::JSON.decode(json))
+  end
+
+  private
+
+  def remove_root(data)
+    if data.is_a?(Hash) && data[collection_name]
+      data[collection_name]
+    else
+      data.first
+    end
+  end
+end

data/lib/gram_v1_client/profile.rb

@@ -0,0 +1,21 @@
+#/lib/GramAccount.rb
+#!/bin/env ruby
+# encoding: utf-8
+
+require 'active_resource'
+class GramProfile < GramV1Client::Base
+  self.element_name = "profiles"
+
+  #Overwrite find_single from ActiveResource::Base to be able to use gram api (/accounts suffix)
+  #https://github.com/rails/activeresource/blob/master/lib/active_resource/base.rb#L991
+  def self.element_path(id, prefix_options = {}, query_options = nil)
+     id += "/profile"
+     super(id, prefix_options, query_options)
+  end
+
+  #Overwrite to_param from ActiveResource::Base to be able to use gram api (id = hruid)
+  #https://github.com/rails/activeresource/blob/master/lib/active_resource/base.rb#L991
+  def to_param
+    self.hruid
+  end
+end

data/lib/gram_v1_client/search.rb

@@ -0,0 +1,43 @@
+#/lib/GramAccount.rb
+#!/bin/env ruby
+# encoding: utf-8
+
+
+# exemple pour rechercher avec un idSoce
+#GramSearch.where(:idSoce => "84185")
+
+
+require 'active_resource'
+class GramV1Client::Search < GramV1Client::Base
+  self.element_name = "search"
+  self.collection_name = "search/uniq"
+
+
+  #Overwrite find_single from ActiveResource::Base to be able to use gram api (/accounts suffix)
+  #https://github.com/rails/activeresource/blob/master/lib/active_resource/base.rb#L991
+  def self.element_path(id, prefix_options = {}, query_options = nil)
+     #query_options = "uniq.json?idSoce=" + id
+     id = "uniq"
+     super(id, prefix_options, query_options)
+  end
+
+  def collection_path(prefix_options = {}, query_options = nil)
+    id = "uniq"
+    super(id, prefix_options, query_options)
+  end
+
+  #Overwrite to_param from ActiveResource::Base to be able to use gram api (id = hruid)
+  #https://github.com/rails/activeresource/blob/master/lib/active_resource/base.rb#L991
+  def to_param
+    self.hruid
+  end
+
+
+  class << self
+    [:hruid,:email,:idSoce,:alias].each do |param|
+      define_method("by_#{param.to_s.underscore}") do |q|
+        self.where(param => q)
+      end
+    end
+  end
+end

data/lib/gram_v1_client/version.rb

@@ -0,0 +1,5 @@
+class GramV1Client
+
+  VERSION = "1.0.0"
+
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: gram_v1_client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alexandre Narbonne
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- alexandre.narbonne@gadz.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gram_v1_client.gemspec
+- lib/gram_v1_client.rb
+- lib/gram_v1_client/account.rb
+- lib/gram_v1_client/base.rb
+- lib/gram_v1_client/configuration.rb
+- lib/gram_v1_client/email.rb
+- lib/gram_v1_client/json_formater.rb
+- lib/gram_v1_client/profile.rb
+- lib/gram_v1_client/search.rb
+- lib/gram_v1_client/version.rb
+homepage: https://github.com/Zooip/gram_v1_client
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.8
+signing_key: 
+specification_version: 4
+summary: Ruby client for the Gadz.org API GrAMv1
+test_files: []
+has_rdoc: