cliskip2 0.0.1 → 0.0.2

data/README.md

@@ -22,7 +22,7 @@ A Ruby wrapper for the SKIP2 REST APIs
 
 ### create new user
     client = Cliskip2::Client.new
-    client.post_user :user => {:name => 'hoge', :email => 'hoge@hoge.com'}
+    client.create_user :user => {:name => 'hoge', :email => 'hoge@hoge.com'}
 
 ### get the user by email
     client = Cliskip2::Client.new
@@ -30,4 +30,24 @@ A Ruby wrapper for the SKIP2 REST APIs
 
 ### update the user by email
     client = Cliskip2::Client.new
-    client.put_user :user => {:name => 'foobar', :email => 'hoge@hoge.com'}
+    client.update_user :user => {:name => 'foobar', :email => 'hoge@hoge.com'}
+
+### search communities by the community-name
+    client = Cliskip2::Client.new
+    client.search_communities({:search => {:name => 'I love ruby'} })
+
+### get a community member
+    client = Cliskip2::Client.new
+    client.get_community_member(community, {:email => 'hoge@hoge.com'})
+
+### join new member to the community
+    client = Cliskip2::Client.new
+    community = client.search_communities({:search => {:name => 'I love ruby'} }).first
+    user = client.get_user :email => 'hoge@hoge.com'
+    client.join_community(community, user)
+
+### leave the member from the community
+    client = Cliskip2::Client.new
+    community = client.search_communities({:search => {:name => 'I love ruby'} }).first
+    member = client.get_community_member(community, {:email => 'hoge@hoge.com'})
+    client.leave_community(community, member)

data/lib/cliskip2/client.rb

@@ -2,6 +2,8 @@
 require 'cliskip2/connection'
 require 'cliskip2/request'
 require 'cliskip2/user'
+require 'cliskip2/community'
+require 'cliskip2/community_participation'
 require 'cliskip2/config'
 
 module Cliskip2
@@ -27,9 +29,13 @@ module Cliskip2
       @current_user ||= Cliskip2::User.new(user_attr['user'])
     end
 
+    # ========================================
+    # User APIs
+    # ========================================
+
     # Create new user by params
     # @return [Cliskip2::User]
-    def post_user params
+    def create_user params
       user_attr = post("/admin/tenants/#{current_user.tenant_id}/users.json", params)
       Cliskip2::User.new(user_attr['user'])
     end
@@ -37,16 +43,52 @@ module Cliskip2
     # Get the user by params
     # @return [Cliskip2::User]
     def get_user params
-      user_attr = get("/admin/tenants/#{current_user.tenant_id}/users/show_by_params.json", params)
+      user_attr = get("/tenants/#{current_user.tenant_id}/users/show_by_params.json", params)
       Cliskip2::User.new(user_attr['user'])
+    rescue Faraday::Error::ResourceNotFound => e
+      nil
     end
 
     # Update the user by params
     # @return [Cliskip2::User]
-    def put_user params
+    def update_user params
       user = get_user :email => params[:user][:email]
       user_attr = put("/admin/tenants/#{current_user.tenant_id}/users/#{user.id}.json", params)
       Cliskip2::User.new(user_attr['user'])
     end
+
+    # ========================================
+    # Community APIs
+    # ========================================
+
+    # Search communities by some conditions
+    # @return [Array<Cliskip2::Community>]
+    def search_communities params
+      community_attrs = get("/tenants/#{current_user.tenant_id}/communities.json", params)
+      community_attrs.map {|community_attr| Cliskip2::Community.new(community_attr['community']) }
+    end
+
+    # Get the community-member by params
+    # @return [Cliskip2::CommunityParticipation]
+    def get_community_member community, params
+      community_participation_attr = get("/tenants/#{current_user.tenant_id}/communities/#{community.id}/community_participations/show_by_params.json", params)
+      Cliskip2::CommunityParticipation.new(community_participation_attr['community_participation'])
+    rescue Faraday::Error::ResourceNotFound => e
+      nil
+    end
+
+    # Join the community by the target-community and params
+    # @return [Cliskip2::CommunityParticipation]
+    def join_community community, user
+      community_participation_attr = post("/tenants/#{current_user.tenant_id}/communities/#{community.id}/community_participations.json", {:community_participation => {:user_id => user.id}})
+      Cliskip2::CommunityParticipation.new(community_participation_attr['community_participation'])
+    end
+
+    # Leave from the community by the target-community and params
+    # @return [Cliskip2::CommunityParticipation]
+    def leave_community community, community_participation
+      community_participation_attr = delete("/tenants/#{current_user.tenant_id}/communities/#{community.id}/community_participations/#{community_participation.id}.json")
+      Cliskip2::CommunityParticipation.new(community_participation_attr['community_participation'])
+    end
   end
 end

data/lib/cliskip2/community.rb

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+require 'cliskip2/base'
+
+module Cliskip2
+  class Community < Cliskip2::Base
+    lazy_attr_reader :id, :name, :description, :image_file_name, :privacy
+  end
+end
+

data/lib/cliskip2/community_participation.rb

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+require 'cliskip2/base'
+
+module Cliskip2
+  class CommunityParticipation < Cliskip2::Base
+    lazy_attr_reader :id, :user_id, :community_id, :admin
+  end
+end
+

data/lib/cliskip2/version.rb

@@ -1,3 +1,3 @@
 module Cliskip2
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cliskip2
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Naoki Maeda
@@ -15,10 +15,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-04 00:00:00 +01:00
+date: 2012-06-18 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  name: faraday_middleware
+  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -31,10 +33,10 @@ dependencies:
         - 7
         version: 0.8.7
   type: :runtime
-  name: faraday_middleware
-  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
+  name: simple_oauth
+  prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -47,10 +49,10 @@ dependencies:
         - 8
         version: 0.1.8
   type: :runtime
-  name: simple_oauth
-  prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -63,10 +65,10 @@ dependencies:
         - 3
         version: 1.7.3
   type: :runtime
-  name: json
-  prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
+  name: oauth
+  prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -78,10 +80,10 @@ dependencies:
         - 4
         version: "0.4"
   type: :runtime
-  name: oauth
-  prerelease: false
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -92,10 +94,10 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  name: rake
-  prerelease: false
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
+  name: rake-compiler
+  prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -106,10 +108,10 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  name: rake-compiler
-  prerelease: false
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -120,8 +122,6 @@ dependencies:
         - 2
         version: "2"
   type: :development
-  name: rspec
-  prerelease: false
   version_requirements: *id007
 description: A Ruby wrapper for the SKIP2 REST APIs
 email: 
@@ -142,6 +142,8 @@ files:
 - lib/cliskip2.rb
 - lib/cliskip2/base.rb
 - lib/cliskip2/client.rb
+- lib/cliskip2/community.rb
+- lib/cliskip2/community_participation.rb
 - lib/cliskip2/config.rb
 - lib/cliskip2/connection.rb
 - lib/cliskip2/request.rb