cobot_client 0.8.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ef6565b60d68b573425d7e0cc139b6a050aedeb
-  data.tar.gz: 3e08fc83c9d58b3e08efc4b3b943fa4d6f20acec
+  metadata.gz: d97efe9d55e36afb226b47dfd1b27fb96a6ca8e5
+  data.tar.gz: a930cbe33ae0f205409e1e4c47ad627b4849b574
 SHA512:
-  metadata.gz: 311d59891c2b4cd2b30c828d5e4c264cfbd22e97f235f23d4cda3c4646f48507d849b158e0234857c071b30b7b49a4215121c1031500e0e45cb0ef6d5f82b489
-  data.tar.gz: 99efdb44a13c364905e7953bf496233f6986544649556505ae07dd330b9b15cd72304a0df36af7471ea695e1c387bf3fd85b9a5a4955bd680f9897323a314dc8
+  metadata.gz: 9376fa5ff793d02f983d80b084f7349e3d6ba3c203915c24aaa56c249d6f932204f81a398b07837c22faf96ac0579f65cae0238d7ecc113e11942316c424b484
+  data.tar.gz: e390b92e01f27a8f3065bb78f68bc2b33981ede0e7914905ee5d37ef51abd3062417c1406e9554b9ab1d334bb6f7eea91e4d18a8aab90da2a008ea64c4ce54db

data/README.md

@@ -24,8 +24,8 @@ Or install it yourself as:
 
 You can install links to your app into the navigation on Cobot. When users click the link an iframe pointing to the given `iframe_url` will be shown.
 
-    client = OAuth2::Client.new <...>
-    CobotClient::NavigationLinkService.new(client, '<access token>', 'co-up').install_links [
+    client = CobotClient::ApiClient.new <access token>
+    CobotClient::NavigationLinkService.new(client, 'co-up').install_links [
       CobotClient::NavigationLink.new(section: 'admin/manage', label: 'My App', iframe_url: 'http://example.com')]
 
 ### Setting up automatic iframe resizing
@@ -64,9 +64,15 @@ There is a module `CobotClient::UrlHelper`. After you include it you can call `c
 
 ### Calling the API
 
-    CobotClient::ApiClient.new('<access token>').list_resources('<subdomain>')
+At the moment there are only a few high-level methods. For more details see the specs.
 
-For more details see the specs.
+    client = CobotClient::ApiClient.new('<access token>')
+    client.list_resources('<subdomain>')
+
+For everything else you can use the low-level get/post/put/delete metods:
+
+    client.get 'www', '/user'
+    client.post 'my-subdomain', '/users', {"email": "joe@doe.com"}
 
 ## Contributing
 

data/lib/cobot_client/navigation_link_service.rb

@@ -3,13 +3,10 @@ require 'oauth2'
 module CobotClient
   # Used to install links into the Cobot navigation of a space.
   class NavigationLinkService
-    include UrlHelper
-
-    # oauth_client - an OAuth2::Client
+    # oauth_client - an CobotClient::ApiClient
     # access_token - an access token string (owner must be admin of the space to be used)
-    def initialize(oauth_client, access_token, space_sudomain)
-      @oauth_client = oauth_client
-      @access_token = access_token
+    def initialize(api_client, space_sudomain)
+      @api_client = api_client
       @subdomain = space_sudomain
     end
 
@@ -30,31 +27,19 @@ module CobotClient
     private
 
     def get_links
-      token.get(cobot_url(@subdomain, "/api/navigation_links")).parsed.map do |attributes|
+      @api_client.get(@subdomain, "/navigation_links").map do |attributes|
         NavigationLink.new attributes
       end
     end
 
     def create_link(link)
-      response = token.post(cobot_url(@subdomain, '/api/navigation_links'), body: {
+      response = @api_client.post(@subdomain, '/navigation_links',
         section: link.section,
         label: link.label,
         iframe_url: link.iframe_url
-      })
-
-      unless successful?(response)
-        raise "Error installing link: #{response.body}"
-      end
-
-      NavigationLink.new response.parsed
-    end
-
-    def token
-      @token ||= OAuth2::AccessToken.new(@oauth_client, @access_token)
-    end
+      )
 
-    def successful?(response)
-      [200, 201].include?(response.status)
+      NavigationLink.new response
     end
   end
 end

data/lib/cobot_client/version.rb

@@ -1,3 +1,3 @@
 module CobotClient
-  VERSION = "0.8.0"
+  VERSION = "1.0.0"
 end

data/spec/cobot_client/navigation_link_service_spec.rb

@@ -1,23 +1,17 @@
 require 'spec_helper'
 
 describe CobotClient::NavigationLinkService, '#install_links' do
-  let(:service) { CobotClient::NavigationLinkService.new(oauth_client, 'token-1', 'co-up') }
-  let(:oauth_client) { double(:oauth_client) }
-
-  before(:each) do
-    @token = double(:token).as_null_object
-    OAuth2::AccessToken.stub(new: @token)
-  end
+  let(:service) { CobotClient::NavigationLinkService.new(api_client, 'co-up') }
+  let(:api_client) { double(:api_client) }
 
   context 'when there are links already' do
     before(:each) do
-      @token.stub(:get).with('https://co-up.cobot.me/api/navigation_links') do double(:response, parsed: [
-        {label: 'test link'}])
-      end
+      api_client.stub(:get).with(
+        'co-up', '/navigation_links') { [{label: 'test link'}] }
     end
 
     it 'installs no links' do
-      @token.should_not_receive(:post)
+      api_client.should_not_receive(:post)
 
       service.install_links [double(:link)]
     end
@@ -29,21 +23,21 @@ describe CobotClient::NavigationLinkService, '#install_links' do
 
   context 'when there are no links installed' do
     let(:link) { double(:link, section: 'admin/manage', label: 'test link', iframe_url: '/test') }
+
     before(:each) do
-      @token.stub(:get).with('https://co-up.cobot.me/api/navigation_links') { double(:response, parsed: []) }
+      api_client.stub(:get).with('co-up', '/navigation_links') { [] }
     end
 
     it 'installs the links' do
-      @token.should_receive(:post).with('https://co-up.cobot.me/api/navigation_links', body: {
+      api_client.should_receive(:post).with('co-up', '/navigation_links', {
         section: 'admin/manage', label: 'test link', iframe_url: '/test'
-      }) { double(:response, status: 201, parsed: {}) }
+      }) { {} }
 
       service.install_links [link]
     end
 
     it 'returns the links created' do
-      response = double(:response, status: 201, parsed: {label: 'test link'})
-      @token.stub(:post) { response }
+      api_client.stub(:post) { {label: 'test link'} }
 
       expect(service.install_links([link]).map(&:label)).to eql(['test link'])
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cobot_client
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Alexander Lang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-22 00:00:00.000000000 Z
+date: 2014-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus