assistly 0.1.5 → 0.2.0

data/lib/assistly/version.rb

@@ -1,4 +1,4 @@
 module Assistly
   # The version of the gem
-  VERSION = '0.1.5'.freeze unless defined?(::Assistly::VERSION)
+  VERSION = '0.2.0'.freeze unless defined?(::Assistly::VERSION)
 end

data/spec/assistly/client/article_spec.rb

@@ -0,0 +1,134 @@
+require 'helper'
+
+describe Assistly::Client do
+  Assistly::Configuration::VALID_FORMATS.each do |format|
+    context ".new(:format => '#{format}')" do
+      before do
+        @client = Assistly::Client.new(:subdomain => "example", :format => format, :consumer_key => 'CK', :consumer_secret => 'CS', :oauth_token => 'OT', :oauth_token_secret => 'OS')
+      end
+
+      describe ".articles" do
+
+        context "lookup" do
+
+          before do
+            stub_get("topics/1/articles.#{format}").
+              to_return(:body => fixture("articles.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should post to the correct resource" do
+            @client.articles(1)
+            a_get("topics/1/articles.#{format}").
+              should have_been_made
+          end
+
+          it "should return the articles" do
+            articles = @client.articles(1)
+    
+            articles.should be_a Array
+            articles.first.article.id.should == 13
+          end
+
+        end
+      end
+      
+      describe ".article" do
+
+        context "lookup" do
+
+          before do
+            stub_get("articles/13.#{format}").
+              to_return(:body => fixture("article.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.article(13)
+            a_get("articles/13.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 cases worth of extended information" do
+            article = @client.article(13)
+
+            article.id.should == 13
+            article.subject.should == "API Tips"
+          end
+
+        end
+      end
+
+      describe ".create_article" do
+
+        context "create" do
+
+          before do
+            stub_post("topics/1/articles.#{format}").
+              to_return(:body => fixture("article_create.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should post to the correct resource" do
+            @client.create_article(1, :subject => "API Tips", :main_content => "Tips on using our API")
+            a_post("topics/1/articles.#{format}").
+              should have_been_made
+          end
+
+          it "should return the articles" do
+            article = @client.create_article(1, :subject => "API Tips", :main_content => "Tips on using our API")
+    
+            article.id.should == 13
+          end
+
+        end
+      end
+      
+      describe ".update_article" do
+
+        context "update" do
+
+          before do
+            stub_put("articles/1.#{format}").
+              to_return(:body => fixture("article_update.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should post to the correct resource" do
+            @client.update_article(1, :subject => "API Tips", :main_content => "Tips on using our API")
+            a_put("articles/1.#{format}").
+              should have_been_made
+          end
+
+          it "should return the new topic" do
+            topic = @client.update_article(1, :subject => "API Tips", :main_content => "Tips on using our API")
+
+            topic.subject.should == "API Tips"
+            topic.main_content.should == "Tips on using our API"
+          end
+
+        end
+      end
+
+      describe ".delete_article" do
+
+        context "delete" do
+
+          before do
+            stub_delete("articles/1.#{format}").
+              to_return(:body => fixture("article_destroy.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should post to the correct resource" do
+            @client.delete_article(1)
+            a_delete("articles/1.#{format}").
+              should have_been_made
+          end
+
+          it "should return a successful response" do
+            topic = @client.delete_article(1)
+            topic.success.should == true
+          end
+
+        end
+      end
+      
+    end
+  end
+end

data/spec/assistly/client/macro_spec.rb

@@ -0,0 +1,204 @@
+require 'helper'
+
+describe Assistly::Client do
+  Assistly::Configuration::VALID_FORMATS.each do |format|
+    context ".new(:format => '#{format}')" do
+      before do
+        @client = Assistly::Client.new(:subdomain => "example", :format => format, :consumer_key => 'CK', :consumer_secret => 'CS', :oauth_token => 'OT', :oauth_token_secret => 'OS')
+      end
+
+      describe ".macros" do
+
+        context "lookup" do
+
+          before do
+            stub_get("macros.#{format}").
+              to_return(:body => fixture("macros.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.macros
+            a_get("macros.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 macros worth of extended information" do
+            macros = @client.macros
+
+            macros.should be_a Array
+            macros.first.macro.id.should == 11
+          end
+
+        end
+      end
+
+      describe ".macro" do
+
+        context "lookup" do
+
+          before do
+            stub_get("macros/13.#{format}").
+              to_return(:body => fixture("macro.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.macro(13)
+            a_get("macros/13.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 cases worth of extended information" do
+            macro = @client.macro(13)
+
+            macro.id.should == 13
+            macro.name.should == "API Macro"
+          end
+
+        end
+      end
+
+      describe ".create_macro" do
+
+        context "create" do
+
+          before do
+            stub_post("macros.#{format}").
+              to_return(:body => fixture("macro_create.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should post to the correct resource" do
+            @client.create_macro("API Macro", :description => "Everything belongs here")
+            a_post("macros.#{format}").
+              should have_been_made
+          end
+
+          it "should return the new macro" do
+            macro = @client.create_macro("API Macro", :description => "Everything belongs here")
+
+            macro.id.should == 12
+            macro.name.should == "API Macro"
+          end
+
+        end
+      end
+
+      describe ".update_macro" do
+
+        context "update" do
+
+          before do
+            stub_put("macros/13.#{format}").
+              to_return(:body => fixture("macro_update.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should post to the correct resource" do
+            @client.update_macro(13, :name => "Updated")
+            a_put("macros/13.#{format}").
+              should have_been_made
+          end
+
+          it "should return the new macro" do
+            macro = @client.update_macro(13, :name => "Updated")
+
+            macro.name.should == "Updated"
+          end
+
+        end
+      end
+
+      describe ".delete_macro" do
+
+        context "delete" do
+
+          before do
+            stub_delete("macros/1.#{format}").
+              to_return(:body => fixture("macro_destroy.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should post to the correct resource" do
+            @client.delete_macro(1)
+            a_delete("macros/1.#{format}").
+              should have_been_made
+          end
+
+          it "should return a successful response" do
+            macro = @client.delete_macro(1)
+            macro.success.should == true
+          end
+
+        end
+      end
+      
+      describe ".macro_actions" do
+
+        context "lookup" do
+
+          before do
+            stub_get("macros/1/actions.#{format}").
+              to_return(:body => fixture("macro_actions.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.macro_actions(1)
+            a_get("macros/1/actions.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 macro actions worth of extended information" do
+            macro_actions = @client.macro_actions(1)
+
+            macro_actions.should be_a Array
+            macro_actions.first.action.slug.should == "set-case-description"
+          end
+
+        end
+      end
+      
+      describe ".macro_action" do
+
+        context "lookup" do
+
+          before do
+            stub_get("macros/1/actions/set-case-description.#{format}").
+              to_return(:body => fixture("macro_action.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.macro_action(1,"set-case-description")
+            a_get("macros/1/actions/set-case-description.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 macro actions worth of extended information" do
+            macro_action = @client.macro_action(1,"set-case-description")
+            macro_action.slug.should == "set-case-description"
+          end
+
+        end
+      end
+      
+      describe ".update_macro_action" do
+
+        context "update" do
+
+          before do
+            stub_put("macros/1/actions/set-case-description.#{format}").
+              to_return(:body => fixture("macro_action_update.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should post to the correct resource" do
+            @client.update_macro_action(1, "set-case-description", :value => "This is my case description")
+            a_put("macros/1/actions/set-case-description.#{format}").
+              should have_been_made
+          end
+
+          it "should return the new macro" do
+            macro_action = @client.update_macro_action(1, "set-case-description", :value => "This is my case description")
+            macro_action.value.should == "Description to be applied"
+          end
+
+        end
+      end
+    end
+  end
+end

data/spec/assistly/client/topic_spec.rb

@@ -0,0 +1,135 @@
+require 'helper'
+
+describe Assistly::Client do
+  Assistly::Configuration::VALID_FORMATS.each do |format|
+    context ".new(:format => '#{format}')" do
+      before do
+        @client = Assistly::Client.new(:subdomain => "example", :format => format, :consumer_key => 'CK', :consumer_secret => 'CS', :oauth_token => 'OT', :oauth_token_secret => 'OS')
+      end
+
+      describe ".topics" do
+
+        context "lookup" do
+
+          before do
+            stub_get("topics.#{format}").
+              to_return(:body => fixture("topics.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.topics
+            a_get("topics.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 topics worth of extended information" do
+            topics = @client.topics
+
+            topics.should be_a Array
+            topics.first.topic.id.should == 1
+          end
+
+        end
+      end
+
+      describe ".topic" do
+
+        context "lookup" do
+
+          before do
+            stub_get("topics/1.#{format}").
+              to_return(:body => fixture("topic.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.topic(1)
+            a_get("topics/1.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 cases worth of extended information" do
+            topic = @client.topic(1)
+
+            topic.id.should == 1
+            topic.name.should == "General"
+          end
+
+        end
+      end
+
+      describe ".create_topic" do
+
+        context "create" do
+
+          before do
+            stub_post("topics.#{format}").
+              to_return(:body => fixture("topic_create.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should post to the correct resource" do
+            @client.create_topic("General", :description => "Everything belongs here")
+            a_post("topics.#{format}").
+              should have_been_made
+          end
+
+          it "should return the new topic" do
+            topic = @client.create_topic("General", :description => "Everything belongs here")
+
+            topic.id.should == 9
+            topic.name.should == "General"
+            topic.description.should == "Everything belongs here"
+          end
+
+        end
+      end
+
+      describe ".update_topic" do
+
+        context "update" do
+
+          before do
+            stub_put("topics/1.#{format}").
+              to_return(:body => fixture("topic_update.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should post to the correct resource" do
+            @client.update_topic(1, :name => "Updated", :description => "Updated Description")
+            a_put("topics/1.#{format}").
+              should have_been_made
+          end
+
+          it "should return the new topic" do
+            topic = @client.update_topic(1, :name => "Updated", :description => "Updated Description")
+
+            topic.name.should == "Updated"
+            topic.description.should == "Updated Description"
+          end
+
+        end
+      end
+
+      describe ".delete_topic" do
+
+        context "delete" do
+
+          before do
+            stub_delete("topics/1.#{format}").
+              to_return(:body => fixture("topic_destroy.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should post to the correct resource" do
+            @client.delete_topic(1)
+            a_delete("topics/1.#{format}").
+              should have_been_made
+          end
+
+          it "should return a successful response" do
+            topic = @client.delete_topic(1)
+            topic.success.should == true
+          end
+
+        end
+      end
+    end
+  end
+end