restpack-group-client 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+group :test do 
+  gem 'rspec', :require => 'spec'
+end
+
+gemspec
+

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Gavin Joyce and RestPack contributors
+
+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,9 @@
+# restpack-group-client [![Build Status](https://api.travis-ci.org/RestPack/restpack-group-client.png?branch=master)](https://travis-ci.org/RestPack/restpack-group-client) [![Code Climate](https://codeclimate.com/github/RestPack/restpack-group-client.png)](https://codeclimate.com/github/RestPack/restpack-group-client) [![Dependency Status](https://gemnasium.com/RestPack/restpack-group-client.png)](https://gemnasium.com/RestPack/restpack-group-client)
+
+A client gem to the restpack-group-service
+
+## Running Tests
+
+```
+rake test
+```

data/Rakefile

@@ -0,0 +1,31 @@
+require "bundler/gem_tasks"
+
+task :default => :test
+task :test => :spec
+
+begin
+  require "rspec/core/rake_task"
+
+  desc "Run all specs"
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = ['-cfs']
+  end
+rescue LoadError
+end
+
+task :gem do
+  ["gem:build", "gem:push"].each do |task|
+    Rake::Task[task].reenable
+    Rake::Task[task].invoke
+  end
+end
+
+namespace :gem do 
+  task :build do
+    sh "gem build restpack-group-client.gemspec"
+  end
+  
+  task :push do
+    sh "gem push restpack-group-client-#{RestPack::Group::Client::VERSION}.gem"
+  end
+end

data/lib/restpack-group-client.rb

@@ -0,0 +1,4 @@
+require 'restpack-group-client/version'
+require 'restpack-group-client/client'
+require 'rest_client'
+require 'yajl/json_gem'

data/lib/restpack-group-client/client.rb

@@ -0,0 +1,38 @@
+require 'uri'
+require_relative 'restpack_client'
+require_relative 'models/group'
+require_relative 'models/membership'
+require_relative 'models/invitation'
+
+module RestPack
+  module Group
+    module Client
+      class Api < RestPackClientApi
+        def groups
+          @group_client ||= GroupClient.new(@options)
+        end
+      end
+
+      class GroupClient < RestPackClientApi
+        def index(params)
+          #TODO: GJ: require channel_id
+          response = get('/api/v1/groups.json', params)
+
+          memberships = []
+          invitations = []
+          groups = []
+
+          memberships = response[:memberships].map { |m| Membership.new(m) } if response[:memberships]
+          invitations = response[:invitations].map { |i| Invitation.new(i) } if response[:invitations]
+          groups = response[:groups].map {|g| Group.new(g, memberships, invitations) } if response[:groups]
+
+          {
+            groups: groups,
+            memberships: memberships,
+            invitations: invitations
+          }
+        end
+      end
+    end
+  end
+end

data/lib/restpack-group-client/models/group.rb

@@ -0,0 +1,33 @@
+module RestPack::Group::Client
+  class Group
+    attr_accessor :id, :name, :description, :channel_id, :created_by_user_id, :created_at, :updated_at, 
+                  :memberships, :invitations
+
+    def initialize(data, memberships, invitations)
+      @id = data[:id]
+      @name = data[:name]
+      @name = data[:description]
+      @name = data[:channel_id]
+      @name = data[:created_by_user_id]
+      @name = data[:created_at]
+      @name = data[:updated_at]
+
+      @memberships = []
+      @invitations = []
+
+      for id in data[:membership_ids]
+        membership = memberships.first { |m| m.id == id }
+        membership.group = self
+        membership.invitation = invitations.first { |i| i.id == membership.invitation_id }
+        @memberships << membership
+      end
+
+      for id in data[:invitation_ids]
+        invitation = invitations.first { |i| m.id == id }
+        invitation.group = self
+        invitation.membership = memberships.first { |m| m.id == invitation.membership_id }
+        @invitations << invitation
+      end
+    end
+  end
+end

data/lib/restpack-group-client/models/invitation.rb

@@ -0,0 +1,24 @@
+module RestPack::Group::Client
+  class Invitation
+    attr_accessor :id, :channel_id, :group_id, :inviter_id, :invitee_id, :status, :email, :access_key,
+                  :remaining_uses, :expires_at, :created_at, :updated_at, :group, :membership
+
+    def initialize(data)
+      @group = nil
+      @membership = nil
+
+      @id = data[:id]
+      @channel_id = data[:channel_id]
+      @group_id = data[:group_id]
+      @inviter_id = data[:inviter_id]
+      @invitee_id = data[:invitee_id]
+      @status = data[:status]
+      @email = data[:email]
+      @access_key = data[:access_key]
+      @remaining_uses = data[:remaining_uses]
+      @expires_at = data[:expires_at]
+      @created_at = data[:created_at]
+      @updated_at = data[:updated_at]
+    end
+  end
+end

data/lib/restpack-group-client/models/membership.rb

@@ -0,0 +1,19 @@
+module RestPack::Group::Client
+  class Membership
+    attr_accessor :id, :channel_id, :group_id, :user_id, :created_at, :updated_at, :invitation_id,
+                  :group, :invitation
+
+    def initialize(data)
+      @group = nil
+      @invitation = nil
+
+      @id = data[:id]
+      @channel_id = data[:channel_id]
+      @group_id = data[:group_id]
+      @user_id = data[:user_id]
+      @created_at = data[:created_at]
+      @updated_at = data[:updated_at]
+      @invitation_id = data[:invitation_id]
+    end
+  end
+end

data/lib/restpack-group-client/restpack_client.rb

@@ -0,0 +1,32 @@
+require 'rest-client'
+
+module RestPack
+  module Group
+    class RestPackClientApi #TODO: GJ: move to common client gem
+      attr_accessor :options
+      def initialize(options = {})
+        @options = {
+          use_https: true,
+          domain: 'localhost:1113',
+          username: nil,
+          password: nil
+        }.merge options
+      end
+
+      def get(path, params = {})
+        url = build_url(path)
+        json = RestClient.get(url, params: params)
+        JSON.parse(json, :symbolize_keys => true)
+      end
+
+      def build_url(path)
+        protocol = @options[:use_https] ? "https://" : "http://"
+        username_and_password = ''
+        if options[:username] || options[:password]
+          username_and_password = "#{options[:username]}:#{options[:password]}@"
+        end
+        protocol + username_and_password + options[:domain] + path
+      end
+    end
+  end
+end

data/lib/restpack-group-client/version.rb

@@ -0,0 +1,7 @@
+module RestPack
+  module Group
+    module Client
+      VERSION = "0.0.1"
+    end
+  end
+end

data/restpack-group-client.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'restpack-group-client'
+
+Gem::Specification.new do |gem|
+  gem.name          = "restpack-group-client"
+  gem.version       = RestPack::Group::Client::VERSION
+  gem.authors       = ["Gavin Joyce"]
+  gem.email         = ["gavinjoyce@gmail.com"]
+  gem.description   = %q{A simple client gem for restpack-group-service}
+  gem.summary       = %q{A simple client gem for restpack-group-service}
+  gem.homepage      = "https://github.com/RestPack"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  gem.add_dependency 'rest-client', '~> 1.6.7'
+  gem.add_dependency 'yajl-ruby', '~> 1.1.0'
+  
+  gem.add_development_dependency 'rspec', '~> 2.12.0'
+  gem.add_development_dependency 'rake', '~> 10.0.3'
+end

data/spec/client_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe RestPack::Group::Client do
+
+  context "when initialising" do
+    describe "with default options" do
+      it "has defaults" do
+        client = RestPack::Group::Client::Api.new
+        client.options[:use_https].should == true
+        client.options[:domain].should == 'localhost:1113'
+      end
+    end
+
+    describe "with specified options" do
+      it "overrides defaults" do
+        client = RestPack::Group::Client::Api.new use_https: false, domain: 'group.services.internal.acme.org'
+        client.options[:use_https].should == false
+        client.options[:domain].should == 'group.services.internal.acme.org'
+      end
+    end
+  end
+
+  context "Group endpoint" do
+    let(:client) { client = RestPack::Group::Client::Api.new(use_https: false, password: '1234') }
+    let(:params) { { channel_id: 1 } }
+    before(:each) do      
+      RestClient.should_receive(:get)
+            .with('http://:1234@localhost:1113/api/v1/groups.json', params: params)
+            .and_return(json)
+
+      @response = client.groups.index(params)
+    end
+
+    context "with data" do
+      let(:json) { File.read('./spec/fixtures/group/index.json') }
+      describe "#index" do
+        it "parses response correctly" do
+          @response[:groups].length.should == 2
+          @response[:memberships].length.should == 3
+          @response[:invitations].length.should == 2
+        end
+
+        it "returns hierarichal group, membership and invitation data" do
+          @response[:groups][0].memberships.length.should == 2
+          @response[:groups][1].memberships.length.should == 1
+
+          @response[:groups][0].invitations.length.should == 2
+          @response[:groups][1].invitations.length.should == 0
+        end
+      end
+    end
+
+    context "with empty data" do
+      let(:json) { File.read('./spec/fixtures/group/index-empty.json') }
+      it "returns valid data" do
+        @response[:groups].length.should == 0
+        @response[:memberships].length.should == 0
+        @response[:invitations].length.should == 0
+      end
+    end
+  end
+
+end

data/spec/fixtures/group/index-empty.json

@@ -0,0 +1,3 @@
+{
+    "groups": []
+}

data/spec/fixtures/group/index.json

@@ -0,0 +1,100 @@
+{
+    "memberships": [
+        {
+            "id": 14,
+            "channel_id": 1,
+            "group_id": 14,
+            "user_id": 4,
+            "created_at": "2013-03-16T08:42:32Z",
+            "updated_at": "2013-03-16T08:42:32Z",
+            "url": "/api/v1/memberships/14.json",
+            "invitation_id": 23
+        },
+        {
+            "id": 12,
+            "channel_id": 1,
+            "group_id": 14,
+            "user_id": 3,
+            "created_at": "2013-03-16T08:36:04Z",
+            "updated_at": "2013-03-16T08:36:04Z",
+            "url": "/api/v1/memberships/12.json",
+            "invitation_id": null
+        },
+        {
+            "id": 13,
+            "channel_id": 1,
+            "group_id": 15,
+            "user_id": 3,
+            "created_at": "2013-03-16T08:36:27Z",
+            "updated_at": "2013-03-16T08:36:27Z",
+            "url": "/api/v1/memberships/13.json",
+            "invitation_id": null
+        }
+    ],
+    "groups": [
+        {
+            "id": 14,
+            "name": "The First Group",
+            "description": "This group is the first",
+            "channel_id": 1,
+            "created_by_user_id": 3,
+            "created_at": "2013-03-16T08:36:04Z",
+            "updated_at": "2013-03-16T08:36:04Z",
+            "url": "/api/v1/groups/14.json",
+            "membership_ids": [
+                12,
+                14
+            ],
+            "invitation_ids": [
+                22,
+                23
+            ]
+        },
+        {
+            "id": 15,
+            "name": "The Second Group",
+            "description": "This group is the second",
+            "channel_id": 1,
+            "created_by_user_id": 3,
+            "created_at": "2013-03-16T08:36:27Z",
+            "updated_at": "2013-03-16T08:36:27Z",
+            "url": "/api/v1/groups/15.json",
+            "membership_ids": [
+                13
+            ],
+            "invitation_ids": []
+        }
+    ],
+    "invitations": [
+        {
+            "id": 23,
+            "channel_id": 1,
+            "group_id": 14,
+            "inviter_id": 3,
+            "invitee_id": 4,
+            "status": "accepted",
+            "email": null,
+            "access_key": "sHjSy",
+            "remaining_uses": null,
+            "expires_at": null,
+            "created_at": "2013-03-16T08:37:18Z",
+            "updated_at": "2013-03-16T08:42:32Z",
+            "url": "/api/v1/invitations/23.json"
+        },
+        {
+            "id": 22,
+            "channel_id": 1,
+            "group_id": 14,
+            "inviter_id": 3,
+            "invitee_id": 142857,
+            "status": "available",
+            "email": null,
+            "access_key": "Tt97X4Hx",
+            "remaining_uses": null,
+            "expires_at": null,
+            "created_at": "2013-03-16T08:36:57Z",
+            "updated_at": "2013-03-16T08:36:57Z",
+            "url": "/api/v1/invitations/22.json"
+        }
+    ]
+}

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:default, :test)
+require 'rspec'
+
+require 'restpack-group-client'

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: restpack-group-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Gavin Joyce
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+description: A simple client gem for restpack-group-service
+email:
+- gavinjoyce@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/restpack-group-client.rb
+- lib/restpack-group-client/client.rb
+- lib/restpack-group-client/models/group.rb
+- lib/restpack-group-client/models/invitation.rb
+- lib/restpack-group-client/models/membership.rb
+- lib/restpack-group-client/restpack_client.rb
+- lib/restpack-group-client/version.rb
+- restpack-group-client.gemspec
+- spec/client_spec.rb
+- spec/fixtures/group/index-empty.json
+- spec/fixtures/group/index.json
+- spec/spec_helper.rb
+homepage: https://github.com/RestPack
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A simple client gem for restpack-group-service
+test_files:
+- spec/client_spec.rb
+- spec/fixtures/group/index-empty.json
+- spec/fixtures/group/index.json
+- spec/spec_helper.rb