boardeffect 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9739c011100cd41a2140744a1f0dea202c1dd48d
-  data.tar.gz: 0265f328399caaae9de55bad37b1c9b66919da5d
+  metadata.gz: 551d74adda142b1193fe13a11f9ed0c53dc42dac
+  data.tar.gz: 871729bb257d0901c6742fd252f0a41d1609f3e0
 SHA512:
-  metadata.gz: db55315e9dba0b1069a1697c46dd9fb14b35113e38853ba97dd086f04fd3752efdc8c4f395bac40c2fbd75a981cf2008aa46d9663a89861b199ce217af364486
-  data.tar.gz: 7ae7d33b4119bea9f6d875b92ac615c4eb5668b604e6e6e86540765273f96fc182535447dd0763a41d0e2936fdf588737759fde869003b179f17af27ebc82fbb
+  metadata.gz: 5bed368e228340bcb9de96612530a3f1ac82fa5f698f6402e88332c48ff13529949706778179ada9611967de6a8948b567be0de7b68a773eb1d030cd0d470834
+  data.tar.gz: ad1e5bbd92571d76b26a435e4a80d80ce8600168178356ea48b9757c3e7ef29b51682b68dfc3806df17e5c68f01942d733475ca361fedf22577eed3e011b1422

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    boardeffect (1.0.0)
+    boardeffect (1.0.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -15,7 +15,7 @@ $ gem install boardeffect
 ```ruby
 require 'boardeffect'
 
-boardeffect = BoardEffect::Client.new(access_token: 'YOUR PERSONAL ACCESS TOKEN', host: 'https://yourportalname.boardeffect.com/')
+boardeffect = BoardEffect::Client.new(access_token: 'API KEY', host: 'https://yourportalname.boardeffect.com/')
 
 announcement = boardeffect.create_announcement({title: "This is a test from the console", body: "This is a body description"}, { workroom_id: 2 })
 p announcement.inspect

data/lib/boardeffect/client.rb

@@ -5,21 +5,31 @@ require 'cgi'
 require 'json'
 
 module BoardEffect
+
   class Client
+
+    API_VERSION = 3
+    API_PATH    = '/api/v3'
+
     def initialize(options = {})
-      if options.key?(:access_token)
-        @auth_header, @auth_value = 'Authorization', "Bearer #{options[:access_token]}"
+      setup_client(options)
+      if !options.key?(:test)
+        auth = auth("#{API_PATH}/auth/api_key.json", { api_key: options[:access_token]})
+        if auth[:success] == true
+          @auth_header, @auth_value = 'Authorization', "Bearer #{auth[:data][:token]}"
+        else
+          raise Error, auth[:error][:message]
+        end
       else
-        @auth_header, @auth_value = 'X-BoardEffectToken', options.fetch(:token)
+         @auth_header, @auth_value = 'Authorization', "Bearer #{options[:access_token]}"
       end
+    end
 
-      @user_agent = options.fetch(:user_agent, 'Ruby BoardEffect::Client')
-
-      @host = (options.key?(:host)) ? options[:host] : 'boardeffect.local'
-
-      @http = Net::HTTP.new(@host)
-
-      @http.use_ssl = (options.key?(:host)) ? true : false
+    def auth(path, attributes)
+      http_request = Net::HTTP::Post.new(path)
+      http_request['Content-Type'] = 'application/json'
+      http_request.body = JSON.generate(attributes)
+      parse(@http.request(http_request))
     end
 
     def get(path, params = nil)
@@ -28,16 +38,25 @@ module BoardEffect
 
     private
 
+    def setup_client(options = {})
+      @user_agent = options.fetch(:user_agent, 'Ruby BoardEffect::Client')
+
+      @host = (options.key?(:host)) ? options[:host] : 'boardeffect.local'
+
+      @http = Net::HTTP.new(URI.parse(@host).host, Net::HTTP.https_default_port())
+      @http.use_ssl = true
+    end
+
     def post(path, attributes)
-      request(Net::HTTP::Post.new(path), attributes)
+      request(Net::HTTP::Post.new(request_uri(path)), attributes)
     end
 
     def put(path, attributes = nil)
-      request(Net::HTTP::Put.new(path), attributes)
+      request(Net::HTTP::Put.new(request_uri(path)), attributes)
     end
 
     def delete(path)
-      request(Net::HTTP::Delete.new(path))
+      request(Net::HTTP::Delete.new(request_uri(path)))
     end
 
     def request(http_request, body_object = nil)
@@ -70,15 +89,16 @@ module BoardEffect
       when Net::HTTPBadRequest
         object = JSON.parse(http_response.body, symbolize_names: true)
 
-        raise Error, "boardeffect api error: #{object.fetch(:message)}"
+        raise Error, "boardeffect api error: #{object[:error][:message]}"
       when Net::HTTPUnauthorized
-        raise AuthenticationError
+        raise AuthenticationError, "boardeffect api error: unexpected #{http_response.code} response from #{@host}"
       else
         raise Error, "boardeffect api error: unexpected #{http_response.code} response from #{@host}"
       end
     end
 
     def request_uri(path, params = nil)
+      path = API_PATH + path unless path.include? API_PATH
       return path if params.nil? || params.empty?
 
       path + '?' + params.map { |k, v| "#{escape(k)}=#{array_escape(v)}" }.join('&')

data/lib/boardeffect/version.rb

@@ -1,3 +1,3 @@
 module BoardEffect
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/boardeffect.rb

@@ -27,81 +27,65 @@ module BoardEffect
 
     # Events
     def get_events(params = nil)
-      raise Error, "Workroom ID is required" unless params[:workroom_id].is_a? Numeric
-      get("/events.json", params)
+      get("/#{workroom_check(params)}events.json", params)
     end
 
     def create_event(attributes, params = nil)
-      raise Error, "Workroom ID is required" unless params[:workroom_id].is_a? Numeric
-      post("/workrooms/#{params[:workroom_id]}/events.json", attributes)
+      post("/#{workroom_check(params)}events.json", attributes)
     end
 
     def update_event(id, attributes, params = nil)
-      raise Error, "Workroom ID is required" unless params[:workroom_id].is_a? Numeric
       raise Error, "Event ID is required" unless id.is_a? Numeric
-      put("/workrooms/#{params[:workroom_id]}/events/#{id}.json", attributes)
+      put("/#{workroom_check(params)}events/#{id}.json", attributes)
     end
 
     def get_event(id, params = nil)
-      raise Error, "Workroom ID is required" unless params[:workroom_id].is_a? Numeric
       raise Error, "Event ID is required" unless id.is_a? Numeric
-      get("/workrooms/#{params[:workroom_id]}/events/#{id}.json")
+      get("/#{workroom_check(params)}events/#{id}.json")
     end
 
     def delete_event(id, params = nil)
       raise Error, "Event ID is required" unless id.is_a? Numeric
-      delete("/workrooms/#{params[:workroom_id]}/events/#{id}.json")
+      delete("/#{workroom_check(params)}events/#{id}.json")
     end
 
     # RSVPS
     def get_rsvps(params = nil)
-      raise Error, "Workroom ID is required" unless params[:workroom_id].is_a? Numeric
       raise Error, "Event ID is required" unless params[:event_id].is_a? Numeric
-      get("/workrooms/#{params[:workroom_id]}/events/#{params[:event_id]}/rsvps.json")
+      get("/#{workroom_check(params)}events/#{params[:event_id]}/rsvps.json")
     end
 
     def create_rsvp(attributes, params = nil)
-      raise Error, "Workroom ID is required" unless params[:workroom_id].is_a? Numeric
       raise Error, "Event ID is required" unless params[:event_id].is_a? Numeric
-      post("/workrooms/#{params[:workroom_id]}/events/#{params[:event_id]}/rsvps.json", attributes)
+      post("/#{workroom_check(params)}events/#{params[:event_id]}/rsvps.json", attributes)
     end
 
     def get_rsvp(rsvp_id, params = nil)
-      raise Error, "Workroom ID is required" unless params[:workroom_id].is_a? Numeric
       raise Error, "Event ID is required" unless params[:event_id].is_a? Numeric
       raise Error, "RSVP ID is required" unless rsvp_id.is_a? Numeric
-      get("/workrooms/#{params[:workroom_id]}/events/#{params[:event_id]}/rsvps/#{rsvp_id}.json")
+      get("/#{workroom_check(params)}events/#{params[:event_id]}/rsvps/#{rsvp_id}.json")
     end
 
     def add_invitee(rsvp_id, attributes, params = nil)
-      raise Error, "Workroom ID is required" unless params[:workroom_id].is_a? Numeric
       raise Error, "Event ID is required" unless params[:event_id].is_a? Numeric
       raise Error, "RSVP ID is required" unless rsvp_id.is_a? Numeric
-      post("/workrooms/#{params[:workroom_id]}/events/#{params[:event_id]}/rsvps/#{rsvp_id}/add_invitee.json", attributes)
+      post("/#{workroom_check(params)}events/#{params[:event_id]}/rsvps/#{rsvp_id}/add_invitee.json", attributes)
     end
 
     def remove_invitee(rsvp_id, attributes, params = nil)
-      raise Error, "Workroom ID is required" unless params[:workroom_id].is_a? Numeric
       raise Error, "Event ID is required" unless params[:event_id].is_a? Numeric
       raise Error, "RSVP ID is required" unless rsvp_id.is_a? Numeric
-      post("/workrooms/#{params[:workroom_id]}/events/#{params[:event_id]}/rsvps/#{rsvp_id}/remove_invitee.json", attributes)
+      post("/#{workroom_check(params)}events/#{params[:event_id]}/rsvps/#{rsvp_id}/remove_invitee.json", attributes)
     end
 
     # Books
     def get_books(params = nil)
-      raise Error, "Workroom ID is required" unless params[:workroom_id].is_a? Numeric
-      get("/books.json", params)
-    end
-
-    def get_paginated_books(params = nil)
-      raise Error, "Workroom ID is required" unless params[:workroom_id].is_a? Numeric
-      get("/books/paginated.json", params)
+      get("/#{workroom_check(params)}books.json", params)
     end
 
     def get_book(book_id, params = nil)
-      raise Error, "Workroom ID is required" unless params[:workroom_id].is_a? Numeric
       raise Error, "Book ID is required" unless book_id.is_a? Numeric
-      get("/workrooms/#{params[:workroom_id]}/books/#{book_id}.json")
+      get("/#{workroom_check(params)}books/#{book_id}.json")
     end
 
     # Clients
@@ -117,21 +101,18 @@ module BoardEffect
 
     # Discussions
     def get_discussions(params = nil)
-      raise Error, "Workroom ID is required" unless params[:workroom_id].is_a? Numeric
-      get("/workrooms/#{params[:workroom_id]}/discussions.json")
+      get("/#{workroom_check(params)}discussions.json")
     end
 
     def get_discussion(discussion_id, params = nil)
-      raise Error, "Workroom ID is required" unless params[:workroom_id].is_a? Numeric
-      get("/workrooms/#{params[:workroom_id]}/discussions/#{discussion_id}.json")
+      get("/#{workroom_check(params)}discussions/#{discussion_id}.json")
     end
 
     # Discussion Posts
     def get_discussion_post(discussion_id, post_id, params = nil)
-      raise Error, "Workroom ID is required" unless params[:workroom_id].is_a? Numeric
       raise Error, "Discussion ID is required" unless discussion_id.is_a? Numeric
       raise Error, "Discussion Post ID is required" unless post_id.is_a? Numeric
-      get("/workrooms/#{params[:workroom_id]}/discussions/#{discussion_id}/discussion_posts/#{post_id}.json")
+      get("/#{workroom_check(params)}discussions/#{discussion_id}/discussion_posts/#{post_id}.json")
     end
 
     # Event Categories
@@ -160,8 +141,7 @@ module BoardEffect
 
     # Surveys
     def get_surveys(params = nil)
-      raise Error, "Workroom ID is required" unless params[:workroom_id].is_a? Numeric
-      get("/workrooms/#{params[:workroom_id]}/surveys.json")
+      get("/#{workroom_check(params)}surveys.json")
     end
 
     # Userclasses
@@ -235,7 +215,8 @@ module BoardEffect
     private
 
     def workroom_check(params = nil)
-      if !params.nil? && params.key?('workroom_id')
+      if !params.nil? && (params.key?('workroom_id') or params.key?(:workroom_id))
+        raise Error, "Workroom ID is required" unless params[:workroom_id].is_a? Numeric
         raise Error, "Workroom ID Can not be 0" if params[:workroom_id].to_i == 0
         "workrooms/#{params[:workroom_id].to_i}/"
       end

data/spec/boardeffect_spec.rb

@@ -6,56 +6,44 @@ describe 'BoardEffect::Client' do
   # Announcements
   describe "get_announcements method" do
     it "fetches the announcements resources and returns the decoded response object" do
-      @request = stub_request(:get, "#@base_url/announcements.json").with(@auth_header).to_return(@json_response.merge(body: '[]'))
-      @client.get_announcements.must_equal([])
-    end
-
-    it 'makes request to get specific workroom announcements' do
-      @request = stub_request(:get, "#@base_url/announcements.json?workroom_id=1")
-      @client.get_announcements(workroom_id: "1")
-    end
-
-    it 'raises an error if workroom_id is 0' do
-      message = "Workroom ID Can not be 0"
-      @request = stub_request(:get, "#@base_url/announcements.json?workroom_id=0").to_return(@json_response.merge(status: 400, body: %({"message":"#{message}"})))
-      exception = proc { @client.get_announcements(workroom_id: "0") }.must_raise(BoardEffect::Error)
-      exception.message.must_include(message)
+      @request = stub_request(:get, "#@base_url/workrooms/1/announcements.json?workroom_id=1").with(@auth_header).to_return(@json_response)
+      @client.get_announcements(workroom_id: 1).must_be_instance_of(BoardEffect::Record)
     end
   end
 
   describe "create_announcement method" do
     it "posts the given attributes to the announcements resource and returns the decoded response object" do
-      @request = stub_request(:post, "#@base_url/announcements.json").with(@json_request.merge(body: { title: "Testing api", body: "This is a description"})).to_return(@json_response.merge(status: 201))
+      @request = stub_request(:post, "#@base_url/workrooms/1/announcements.json").with(@json_request.merge(body: { title: "Testing api", body: "This is a description"})).to_return(@json_response.merge(status: 201))
       @client.create_announcement({title: "Testing api", body: "This is a description"}, {workroom_id: 1}).must_be_instance_of(BoardEffect::Record)
     end
   end
 
   describe "update_announcement method" do
     it "puts the given attributes to the announcements resource and returns the decoded response object" do
-      @request = stub_request(:put, "#@base_url/announcements/1.json").with(@json_request.merge(body: { title: "Testing api update", body: "This is a description"})).to_return(@json_response.merge(status: 201))
-      @client.update_announcement(1, {title: "Testing api update", body: "This is a description"}).must_be_instance_of(BoardEffect::Record)
+      @request = stub_request(:put, "#@base_url/workrooms/1/announcements/1.json").with(@json_request.merge(body: { title: "Testing api update", body: "This is a description"})).to_return(@json_response.merge(status: 201))
+      @client.update_announcement(1, {title: "Testing api update", body: "This is a description"}, workroom_id: 1).must_be_instance_of(BoardEffect::Record)
     end
   end
 
   describe "get_announcement method" do
     it "fetches the announcement resources and returns the decoded response object" do
-      @request = stub_request(:get, "#@base_url/announcements/1.json").with(@auth_header).to_return(@json_response.merge(body: '[]'))
-      @client.get_announcement(1).must_equal([])
+      @request = stub_request(:get, "#@base_url/workrooms/1/announcements/1.json").with(@auth_header).to_return(@json_response)
+      @client.get_announcement(1, workroom_id: 1).must_be_instance_of(BoardEffect::Record)
     end
   end
 
   describe "delete_announcement method" do
     it "deletes the announcement resource" do
-      @request = stub_request(:delete, "#@base_url/announcements/1.json").with(@auth_header).to_return(status: 204)
-      @client.delete_announcement(1).must_equal(:no_content)
+      @request = stub_request(:delete, "#@base_url/workrooms/1/announcements/1.json").with(@auth_header).to_return(status: 204)
+      @client.delete_announcement(1, workroom_id: 1).must_equal(:no_content)
     end
   end
 
   # Events
   describe "get_events method" do
     it "fetches the events resources and returns the decoded response object" do
-      @request = stub_request(:get, "#@base_url/events.json?workroom_id=1").with(@auth_header).to_return(@json_response.merge(body: '[]'))
-      @client.get_events(workroom_id: 1).must_equal([])
+      @request = stub_request(:get, "#@base_url/workrooms/1/events.json?workroom_id=1").with(@auth_header).to_return(@json_response)
+      @client.get_events(workroom_id: 1).must_be_instance_of(BoardEffect::Record)
     end
   end
 
@@ -77,8 +65,8 @@ describe 'BoardEffect::Client' do
 
   describe "get_event method" do
     it "fetches the event resources and returns the decoded response object" do
-      @request = stub_request(:get, "#@base_url/workrooms/1/events/1.json").with(@auth_header).to_return(@json_response.merge(body: '[]'))
-      @client.get_event(1, workroom_id: 1).must_equal([])
+      @request = stub_request(:get, "#@base_url/workrooms/1/events/1.json").with(@auth_header).to_return(@json_response)
+      @client.get_event(1, workroom_id: 1).must_be_instance_of(BoardEffect::Record)
     end
   end
 
@@ -92,8 +80,8 @@ describe 'BoardEffect::Client' do
   # RSVPS
   describe "get_rsvps method" do
     it "fetches the rsvps resources and returns the decoded response object" do
-      @request = stub_request(:get, "#@base_url/workrooms/1/events/1/rsvps.json").with(@auth_header).to_return(@json_response.merge(body: '[]'))
-      @client.get_rsvps(workroom_id: 1, event_id: 1).must_equal([])
+      @request = stub_request(:get, "#@base_url/workrooms/1/events/1/rsvps.json").with(@auth_header).to_return(@json_response)
+      @client.get_rsvps(workroom_id: 1, event_id: 1).must_be_instance_of(BoardEffect::Record)
     end
   end
 
@@ -107,8 +95,8 @@ describe 'BoardEffect::Client' do
 
   describe "get_rsvp method" do
     it "fetches the rsvp resource and returns the decoded response object" do
-      @request = stub_request(:get, "#@base_url/workrooms/1/events/1/rsvps/1.json").with(@auth_header).to_return(@json_response.merge(body: '[]'))
-      @client.get_rsvp(1, {workroom_id: 1, event_id: 1}).must_equal([])
+      @request = stub_request(:get, "#@base_url/workrooms/1/events/1/rsvps/1.json").with(@auth_header).to_return(@json_response)
+      @client.get_rsvp(1, {workroom_id: 1, event_id: 1}).must_be_instance_of(BoardEffect::Record)
     end
   end
 
@@ -126,11 +114,11 @@ describe 'BoardEffect::Client' do
     end
   end
 
-  # Userclasses
+  # # Userclasses
   describe "get_userclasses method" do
     it "fetches the userclasses resources and returns the decoded response object" do
-      @request = stub_request(:get, "#@base_url/userclasses.json").with(@auth_header).to_return(@json_response.merge(body: '[]'))
-      @client.get_userclasses.must_equal([])
+      @request = stub_request(:get, "#@base_url/userclasses.json").with(@auth_header).to_return(@json_response)
+      @client.get_userclasses.must_be_instance_of(BoardEffect::Record)
     end
   end
 
@@ -152,8 +140,8 @@ describe 'BoardEffect::Client' do
 
   describe "get_userclass method" do
     it "fetches the userclass resources and returns the decoded response object" do
-      @request = stub_request(:get, "#@base_url/userclasses/1.json").with(@auth_header).to_return(@json_response.merge(body: '[]'))
-      @client.get_userclass(1).must_equal([])
+      @request = stub_request(:get, "#@base_url/userclasses/1.json").with(@auth_header).to_return(@json_response)
+      @client.get_userclass(1).must_be_instance_of(BoardEffect::Record)
     end
   end
 
@@ -164,70 +152,66 @@ describe 'BoardEffect::Client' do
     end
   end
 
-  # Books
+  # # Books
   describe "get_books method" do
     it "fetches the books resources and returns the decoded response object" do
-      @request = stub_request(:get, "#@base_url/books.json?workroom_id=1").with(@auth_header).to_return(@json_response.merge(body: '[]'))
-      @client.get_books(workroom_id: 1).must_equal([])
-    end
-    it "fetches the books resources and returns the decoded response object" do
-      @request = stub_request(:get, "#@base_url/books/paginated.json?workroom_id=1&page=1").with(@auth_header).to_return(@json_response.merge(body: '[]'))
-      @client.get_paginated_books(workroom_id: 1, page: 1).must_equal([])
+      @request = stub_request(:get, "#@base_url/workrooms/1/books.json?workroom_id=1").with(@auth_header).to_return(@json_response)
+      @client.get_books(workroom_id: 1).must_be_instance_of(BoardEffect::Record)
     end
   end
 
   describe "get_book method" do
     it "fetches the book resource and returns the decoded response object" do
-      @request = stub_request(:get, "#@base_url/workrooms/1/books/1.json?").with(@auth_header).to_return(@json_response.merge(body: '[]'))
-      @client.get_book(1, workroom_id: 1).must_equal([])
+      @request = stub_request(:get, "#@base_url/workrooms/1/books/1.json?").with(@auth_header).to_return(@json_response)
+      @client.get_book(1, workroom_id: 1).must_be_instance_of(BoardEffect::Record)
     end
   end
 
-  # Clients
+  # # Clients
   describe "get_client method" do
     it "fetches the client resource and returns the decoded response object" do
-      @request = stub_request(:get, "#@base_url/clients/1.json?").with(@auth_header).to_return(@json_response.merge(body: '[]'))
-      @client.get_client(1).must_equal([])
+      @request = stub_request(:get, "#@base_url/clients/1.json?").with(@auth_header).to_return(@json_response)
+      @client.get_client(1).must_be_instance_of(BoardEffect::Record)
     end
   end
 
-  # Custom Fields
+  # # Custom Fields
   describe "get_custom_fields method" do
     it "fetches the custom fields resource and returns the decoded response object" do
       attributes = { "id" => 0, "label" => "string", "field_type" => "string", "options" => "string"}
-      @request = stub_request(:get, "#@base_url/custom_fields.json?").with(@auth_header).to_return(@json_response.merge(body: attributes.to_json))
+      @request = stub_request(:get, "#@base_url/custom_fields.json?").with(@auth_header).to_return(@json_response)
       @client.get_custom_fields.must_be_instance_of(BoardEffect::Record)
     end
   end
 
-  # Discussions
+  # # Discussions
   describe "get_discussions method" do
     it "fetches the discussions resource and returns the decoded response object" do
-      @request = stub_request(:get, "#@base_url/workrooms/1/discussions.json").with(@auth_header).to_return(@json_response.merge(body: '[]'))
-      @client.get_discussions(workroom_id: 1).must_equal([])
+      @request = stub_request(:get, "#@base_url/workrooms/1/discussions.json").with(@auth_header).to_return(@json_response)
+      @client.get_discussions(workroom_id: 1).must_be_instance_of(BoardEffect::Record)
     end
   end
 
   describe "get_discussion method" do
     it "fetches the discussion resource and returns the decoded response object" do
-      @request = stub_request(:get, "#@base_url/workrooms/1/discussions/1.json").with(@auth_header).to_return(@json_response.merge(body: '[]'))
-      @client.get_discussion(1, workroom_id: 1).must_equal([])
+      @request = stub_request(:get, "#@base_url/workrooms/1/discussions/1.json").with(@auth_header).to_return(@json_response)
+      @client.get_discussion(1, workroom_id: 1).must_be_instance_of(BoardEffect::Record)
     end
   end
 
-  # Discussion Posts
+  # # Discussion Posts
   describe "get_discussion_post" do
     it "fetches the discussion post resource and returns the decoded response object" do
-      @request = stub_request(:get, "#@base_url/workrooms/1/discussions/1/discussion_posts/1.json").with(@auth_header).to_return(@json_response.merge(body: '[]'))
-      @client.get_discussion_post(1, 1, workroom_id: 1).must_equal([])
+      @request = stub_request(:get, "#@base_url/workrooms/1/discussions/1/discussion_posts/1.json").with(@auth_header).to_return(@json_response)
+      @client.get_discussion_post(1, 1, workroom_id: 1).must_be_instance_of(BoardEffect::Record)
     end
   end
 
-  # Event Categories
+  # # Event Categories
   describe "get_event_categories" do
     it "fetches the event category resource and returns the decoded response object" do
-      @request = stub_request(:get, "#@base_url/eventcolors.json").with(@auth_header).to_return(@json_response.merge(body: '[]'))
-      @client.get_event_categories().must_equal([])
+      @request = stub_request(:get, "#@base_url/eventcolors.json").with(@auth_header).to_return(@json_response)
+      @client.get_event_categories().must_be_instance_of(BoardEffect::Record)
     end
   end
 
@@ -249,61 +233,61 @@ describe 'BoardEffect::Client' do
 
   describe "get_event_category" do
     it "fetches the event category resource and returns the decoded response object" do
-      @request = stub_request(:get, "#@base_url/eventcolors/1.json").with(@auth_header).to_return(@json_response.merge(body: '[]'))
-      @client.get_event_category(1).must_equal([])
+      @request = stub_request(:get, "#@base_url/eventcolors/1.json").with(@auth_header).to_return(@json_response)
+      @client.get_event_category(1).must_be_instance_of(BoardEffect::Record)
     end
   end
 
   describe "delete_event_category" do
     it "fetches the event category resource and returns the decoded response object" do
-      @request = stub_request(:delete, "#@base_url/eventcolors/1.json").with(@auth_header).to_return(@json_response.merge(body: '[]'))
-      @client.delete_event_category(1).must_equal([])
+      @request = stub_request(:delete, "#@base_url/eventcolors/1.json").with(@auth_header).to_return(@json_response)
+      @client.delete_event_category(1).must_be_instance_of(BoardEffect::Record)
     end
   end
 
-  # Surveys
+  # # Surveys
   describe "get_surveys" do
     it "fetches the survey resource and returns the decoded response object" do
-      @request = stub_request(:get, "#@base_url/workrooms/1/surveys.json").with(@auth_header).to_return(@json_response.merge(body: '[]'))
-      @client.get_surveys(workroom_id: 1).must_equal([])
+      @request = stub_request(:get, "#@base_url/workrooms/1/surveys.json").with(@auth_header).to_return(@json_response)
+      @client.get_surveys(workroom_id: 1).must_be_instance_of(BoardEffect::Record)
     end
   end
 
-  # Users
+  # # Users
   describe "get_users" do
     it "fetches the users resource and returns the decoded response object" do
-      @request = stub_request(:get, "#@base_url/users.json").with(@auth_header).to_return(@json_response.merge(body: '[]'))
-      @client.get_users.must_equal([])
+      @request = stub_request(:get, "#@base_url/users.json").with(@auth_header).to_return(@json_response)
+      @client.get_users.must_be_instance_of(BoardEffect::Record)
     end
   end
 
   describe "get_user" do
     it "fetches the user resource and returns the decoded response object" do
-      @request = stub_request(:get, "#@base_url/users/1.json").with(@auth_header).to_return(@json_response.merge(body: '[]'))
-      @client.get_user(1).must_equal([])
+      @request = stub_request(:get, "#@base_url/users/1.json").with(@auth_header).to_return(@json_response)
+      @client.get_user(1).must_be_instance_of(BoardEffect::Record)
     end
   end
 
-  # Workgroups
+  # # Workgroups
   describe "get_workgroups" do
     it "fetches the workgroups resource and returns the decoded response object" do
-      @request = stub_request(:get, "#@base_url/committeegroups.json").with(@auth_header).to_return(@json_response.merge(body: '[]'))
-      @client.get_workgroups.must_equal([])
+      @request = stub_request(:get, "#@base_url/committeegroups.json").with(@auth_header).to_return(@json_response)
+      @client.get_workgroups.must_be_instance_of(BoardEffect::Record)
     end
   end
 
   describe "get_workgroup" do
     it "fetches the workgroup resource and returns the decoded response object" do
-      @request = stub_request(:get, "#@base_url/committeegroups/1.json").with(@auth_header).to_return(@json_response.merge(body: '[]'))
-      @client.get_workgroup(1).must_equal([])
+      @request = stub_request(:get, "#@base_url/committeegroups/1.json").with(@auth_header).to_return(@json_response)
+      @client.get_workgroup(1).must_be_instance_of(BoardEffect::Record)
     end
   end
 
-  # Workrooms
+  # # Workrooms
   describe "get_workrooms method" do
     it "fetches the workrooms resources and returns the decoded response object" do
-      @request = stub_request(:get, "#@base_url/workrooms.json").with(@auth_header).to_return(@json_response.merge(body: '[]'))
-      @client.get_workrooms.must_equal([])
+      @request = stub_request(:get, "#@base_url/workrooms.json").with(@auth_header).to_return(@json_response)
+      @client.get_workrooms.must_be_instance_of(BoardEffect::Record)
     end
   end
 
@@ -325,8 +309,8 @@ describe 'BoardEffect::Client' do
 
   describe "get_workroom method" do
     it "fetches the workroom resources and returns the decoded response object" do
-      @request = stub_request(:get, "#@base_url/workrooms/1.json").with(@auth_header).to_return(@json_response.merge(body: '[]'))
-      @client.get_workroom(1).must_equal([])
+      @request = stub_request(:get, "#@base_url/workrooms/1.json").with(@auth_header).to_return(@json_response)
+      @client.get_workroom(1).must_be_instance_of(BoardEffect::Record)
     end
   end
 

data/spec/spec_helper.rb

@@ -9,18 +9,13 @@ end
 module BeforeHelper
   before do
     @token = 'b73cbb117c89c9ed9d8009453655e36965bdb1ca491583b22b85c7d499f8a658b1e3fff221fbb2a141880d2be3a466'
-
-    @base_url = 'http://boardeffect.local'
-
+    @base_url = 'https://boardeffect.local/api/v3'
     @entry_id = @project_id = @id = 1234
-
-    @auth_header = {headers: {'Authorization' => "Bearer #{@token}", 'User-Agent'=>'Ruby BoardEffect::Client', 'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3'}}
-
+    @client = BoardEffect::Client.new(access_token: @token, host: 'http://boardeffect.local', test: true)
+    @auth_header = @auth_value = {headers: {'Authorization' => "Bearer #{@token}", 'User-Agent'=>'Ruby BoardEffect::Client', 'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3'}}
     @json_request = {headers: {'Authorization' => "Bearer #{@token}", 'User-Agent'=>'Ruby BoardEffect::Client', 'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3'}}
-
-    @json_response = {headers: {'Content-Type' => 'application/json;charset=utf-8'}, body: '{}'}
-
-    @client = BoardEffect::Client.new(access_token: @token)
+    @json_response = {headers: {'Content-Type' => 'application/json;charset=utf-8'}, body: '{ "success": true, "data": [] }'}
+    @json_error = {headers: {'Content-Type' => 'application/json;charset=utf-8'}, body: '{ "success": false, "error": { "title": "There was an error", "message": "Something went wrong"} }'}
   end
 
   after do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boardeffect
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Mark Hunt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-21 00:00:00.000000000 Z
+date: 2016-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake