gram_v2_client 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 980e1bcfb5ad1ea738251c5e8827456c8c108336
+  data.tar.gz: c46d443d827940ade078db8a74b74543ad41ccce
+SHA512:
+  metadata.gz: caafac5ebb681161edf6aedf30b7ead4c0663096c422c561a5458b2d126eb2b60a9f07834f58f88ec124d2b0403170df280c14ea3d8662d03811a6ab7b04a069
+  data.tar.gz: 2bd8ed2585024b6d85acbf51a599911bfb50053c0d665ba9e45144f4b4b25db17b6b6126dc1ae3fd7c208a4a381cc38420569deb87873967d165064ea5f0c887

data/.gitignore

@@ -0,0 +1,51 @@
+.idea
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gram_v2_client.gemspec
+gemspec
+gem "codeclimate-test-reporter", group: :test, require: nil

data/README.md

@@ -0,0 +1,131 @@
+# GramV2Client
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gram_v2_client', git: 'https://github.com/gadzorg/gram2_api_client_ruby.git'
+```
+
+And then execute:
+
+    $ bundle
+
+## Setup
+  
+  Before being used GramV2Client must be configured. In Rails app, put it in an Initializer.
+
+```ruby
+GramV2Client.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
+ GramV2Client.init
+ 
+ 
+```
+
+Tips : you can init a config for the test environment (local instance of gram2_api_server and default admin account) with `GramV2Client.init_test`.
+## Usage
+This client is based on ActiveRessource thus you can manipulate `account`, `group` and `role` as Ruby objects.
+### Account
+#### Find
+```ruby
+# Return all accounts
+GramV2Client::Account.all
+
+# Return first account
+GramV2Client::Account.first
+
+# Find account with uuid = "c2ce6327-158d-458a-9e76-c89ac9c14a14"
+account = GramV2Client::Account.find("c2ce6327-158d-458a-9e76-c89ac9c14a14")
+puts account.firstname
+puts account.lastname
+#=> John
+#=> Doe
+````
+#### Update
+```ruby
+account = GramV2Client::Account.find("c2ce6327-158d-458a-9e76-c89ac9c14a14")
+account.firstname = "Johny"
+account.save
+````
+
+#### Create
+```ruby
+account = GramV2Client::Account.new(
+  firstname: "John", 
+  lastname: "Doe", 
+  email: "john.doe@test.test", 
+  password: "passw0rd",
+  is_gadz: false
+  )
+account.save
+````
+Or
+```ruby
+account = GramV2Client::Account.create(
+  firstname: "John", 
+  lastname: "Doe", 
+  email: "john.doe@test.test", 
+  password: "passw0rd",
+  is_gadz: false
+  )
+````
+
+### Group
+#### Find
+```ruby
+# Return all groups
+GramV2Client::Group.all
+
+# Return first group
+GramV2Client::Group.first
+
+# Find group with uuid = "ffa43f12-f47b-44ea-ad81-f7ede483f394"
+group = GramV2Client::group.find("ffa43f12-f47b-44ea-ad81-f7ede483f394")
+puts group.short_name
+#=> My_group
+````
+
+#### Members
+```ruby
+# Find members of group with uuid = "ffa43f12-f47b-44ea-ad81-f7ede483f394"
+group = GramV2Client::group.find("ffa43f12-f47b-44ea-ad81-f7ede483f394").account
+# Return Accounts collection
+````
+
+##### Add/remove member
+```ruby
+group = GramV2Client::group.find("ffa43f12-f47b-44ea-ad81-f7ede483f394")
+account = GramV2Client::Account.find("c2ce6327-158d-458a-9e76-c89ac9c14a14")
+
+# Add account with uuid = "c2ce6327-158d-458a-9e76-c89ac9c14a14" to group with uuid = "ffa43f12-f47b-44ea-ad81-f7ede483f394"
+account.add_to_group(group)
+
+# Remove account with uuid = "c2ce6327-158d-458a-9e76-c89ac9c14a14" to group with uuid = "ffa43f12-f47b-44ea-ad81-f7ede483f394"
+account.remove_from_group(group)
+
+````
+#### Role
+Roles management is exactly the same as group management. 
+## 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/gadzorg/gram2_api_client_ruby.
+
+
+## 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,7 @@
+
+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_v2_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_v2_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_v2_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gram_v2_client"
+  spec.version       = GramV2Client::VERSION
+  spec.authors       = ["Alexandre Narbonne","Dorian Becker"]
+  spec.email         = ["alexandre.narbonne@gadz.org", "dorian.becker@gadz.org"]
+
+  spec.summary       = "Ruby client for the Gadz.org API GrAMv2"
+  spec.homepage      = "https://github.com/gadzorg/gram2_api_client_ruby"
+  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_v2_client.rb

@@ -0,0 +1,18 @@
+require 'active_resource'
+require 'gram_v2_client/configuration'
+require 'gram_v2_client/base'
+require 'gram_v2_client/account'
+require 'gram_v2_client/group'
+require 'gram_v2_client/role'
+require 'gram_v2_client/version'
+
+class GramV2Client
+  def self.init_test
+    GramV2Client.configure do |c|
+    c.site = "http://localhost:3000/api/v2"
+    c.user = "admin"
+    c.password = "password"
+    end
+  end
+
+end

data/lib/gram_v2_client/account.rb

@@ -0,0 +1,21 @@
+require 'active_resource'
+require 'gram_v2_client/base'
+
+class GramV2Client::Account < GramV2Client::Base
+
+  def add_to_group(group)
+    post(self.uuid + "/groups", group_uuid: group.uuid)
+  end
+
+  def remove_from_group(group)
+    delete(self.uuid + "/groups/" + group.uuid)
+  end
+
+  def add_role(role)
+    post(self.uuid + "/roles", role_uuid: role.uuid)
+  end
+
+  def revoke_role(role)
+    delete(self.uuid + "/roles/" + role.uuid)
+  end
+end

data/lib/gram_v2_client/base.rb

@@ -0,0 +1,63 @@
+require 'active_resource'
+
+class GramV2Client::Base < ActiveResource::Base
+  # This is set to enable Configuration change at runtime.
+  
+  def to_param
+    uuid
+  end
+
+  class << self
+    def site
+      if GramV2Client.configuration.site
+        if super.to_s != URI.parse(GramV2Client.configuration.site).to_s
+          reload_config
+        end
+      end
+      super
+    end
+
+    def user()
+      if GramV2Client.configuration.user
+        if super.to_s != GramV2Client.configuration.user
+          reload_config
+        end
+      end
+      super
+    end
+
+    def password()
+      if GramV2Client.configuration.password
+        if super.to_s != GramV2Client.configuration.password
+          reload_config
+        end
+      end
+      super
+    end
+
+    def proxy()
+      if GramV2Client.configuration.proxy
+        if super.to_s != URI.parse(GramV2Client.configuration.proxy).to_s
+          reload_config
+        end
+      end
+      super
+    end
+
+
+    def reload_config
+      self.site= GramV2Client.configuration.site
+      self.user= GramV2Client.configuration.user
+      self.password=GramV2Client.configuration.password
+      self.proxy=GramV2Client.configuration.proxy
+    end
+  end
+
+end
+
+
+
+
+
+
+

data/lib/gram_v2_client/configuration.rb

@@ -0,0 +1,28 @@
+class GramV2Client
+  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_v2_client/group.rb

@@ -0,0 +1,10 @@
+require 'gram_v2_client/base'
+require 'active_resource'
+
+
+class GramV2Client::Group < GramV2Client::Base
+
+  def accounts
+    GramV2Client::Account.find(:all, from: self.class.site.to_s + "/groups/" + self.uuid + "/accounts")
+  end
+end

data/lib/gram_v2_client/role.rb

@@ -0,0 +1,8 @@
+require 'gram_v2_client/base'
+require 'active_resource'
+
+class GramV2Client::Role < GramV2Client::Base
+  def accounts
+    GramV2Client::Account.find(:all, from: self.class.site.to_s + "/roles/" + self.uuid + "/accounts")
+  end
+end

data/lib/gram_v2_client/version.rb

@@ -0,0 +1,5 @@
+class GramV2Client
+
+  VERSION = "2.1.0"
+
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: gram_v2_client
+version: !ruby/object:Gem::Version
+  version: 2.1.0
+platform: ruby
+authors:
+- Alexandre Narbonne
+- Dorian Becker
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-09 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
+- dorian.becker@gadz.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/vcs.xml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gram_v2_client.gemspec
+- lib/gram_v2_client.rb
+- lib/gram_v2_client/account.rb
+- lib/gram_v2_client/base.rb
+- lib/gram_v2_client/configuration.rb
+- lib/gram_v2_client/group.rb
+- lib/gram_v2_client/role.rb
+- lib/gram_v2_client/version.rb
+homepage: https://github.com/gadzorg/gram2_api_client_ruby
+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 GrAMv2
+test_files: []
+has_rdoc: