errbit_plugin 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 379974aa8a736ab97c68e86d35a8a4abe74cf078
-  data.tar.gz: 68538a72756d7286cab6603f2fd5ff0eaf853a9e
+  metadata.gz: 0da88b0c10182c8a6cdcd9027d600a3149dc2e29
+  data.tar.gz: 0ebd3654aff4015119a467f1db58967f3f5c70b4
 SHA512:
-  metadata.gz: 0946dc453bf1c7a0eb1ec1091edd135287e7734684fb3291b2e29241739fbaa321adedde1ba71f14b2d29a60c72a90b9d010fbea810475937136616970f7b232
-  data.tar.gz: 8487cad20bfe5f99001a0a3974424b4de1fea6a100336ff344bbe6fc72aa263d8e98c2c6d2dea9448fb4579b31f3484dc9ad9e6d522e87a64fb0cdd473e00b1c
+  metadata.gz: 67de6652286cec7dc1f78c2496235a2f10460786e7327c0900b66bef4d394d567d216de034df19757a0c7892e06547a51b655424350742b36a2bd0a249423a52
+  data.tar.gz: c33bc5ac88fe5707687e63c8ee7aaba80c90a361d0d6e9bdba064cbf26c1cde1e9862ab3b6ec9a570ca763dfc2fda0f876a6aa93043b67f5c6ca113d07f003e7

data/.travis.yml

@@ -1,13 +1,15 @@
 language: ruby
 env:
     - COVERAGE=true
+before_install:
+  - gem install bundler
 script: bundle exec rspec spec
 rvm:
-  - 2.0.0
-  - 1.9.3
-  - rbx-19mode
+  - 2.1
+  - 2.2
+  - 2.3.0
+  - rbx-2
   - ruby-head
 matrix:
   allow_failures:
-    - rvm: rbx-19mode
     - rvm: ruby-head

data/README.md

@@ -16,7 +16,9 @@ errbit to an issue in an external issue tracker like Github. An app within
 errbit can be associated an issue tracker or not. When there is an association,
 errbit users can choose 'create issue' from an error page which will both
 create an issue on the external issue tracker out of the given error and link
-that issue to the errbit error.
+that issue to the errbit error. Likewise, a user can also choose 'close issue'
+to close the issue on the external issue tracker, if your plugin provides a 
+method to do so.
 
 Your issue tracker plugin is responsible for providing the interface defined by
 ErrbitPlugin::IssueTracker. All of the required methods must be implemented and
@@ -42,7 +44,8 @@ class MyIssueTracker < ErrbitPlugin::IssueTracker
         placeholder: "Some placeholder text"
       },
       password: {
-        placeholder: "Some more placeholder text"
+        placeholder: "Some more placeholder text",
+        label: "Passphrase" # a label to use in the UI instead of 'password'
       }
     }
   end
@@ -63,30 +66,53 @@ class MyIssueTracker < ErrbitPlugin::IssueTracker
   # errbit know by returning a Boolean here
   def configured?
     # In this case, we'll say this issue tracker is configured when username
-    # is set
-    !!params['username']
+    # and password are set
+    options[:username].present? && options[:password].present?
   end
 
   # Called to validate user input. Just return a hash of errors if there are
   # any
   def errors
-    if @params['field_one']
+    if options[:username]
       {}
     else
-      { :field_one, 'Field One must be present' }
+      { field_one: 'username must be present' }
     end
   end
 
   # This is where you actually go create the issue on the external issue
-  # tracker. You get access to everything in params, a problem resource and a
-  # user resource (reported_by). Once you've created an external issue, save
-  # its type and url on the problem resource.
-  def create_issue(problem, reported_by = nil)
+  # tracker. You get access to everything in options, an issue title, body and
+  # a user record representing the user who's creating the issue.
+  #
+  # Return a string with a link to the issue
+  def create_issue(title, body, user: {})
     # Create an issue! Then update the problem to link it.
-    problem.update_attributes(
-      :issue_type => 'bug',
-      :issue_link => 'http://some-remote-tracker.com/mynewissue'
-    )
+
+    'http://sometracker.com/my/issue/123'
+  end
+
+  # This method is optional. Errbit will create body text for your issue by
+  # calling render_to_string with some arguments. If you want control over
+  # those arguments, you can specify them here. You can control which file is
+  # rendered and anything else Rails allows you to specify as arguments in
+  # render_to_string.
+  #
+  # If you don't implement this method, Errbit will render a body using a
+  # default template
+  #
+  # @see http://apidock.com/rails/ActionController/Base/render_to_string
+  def render_body_args
+    # In this example, we want to render a special file
+    ['/path/to/some/template', formats: [:rdoc]]
+  end
+
+  # This method is optional, and is where you actually go close the issue on
+  # the external issue tracker. You get access to everything in options, a
+  # string with a link to the issue # and a user resource.
+  #
+  # return true if successful, false otherwise
+  def close_issue(issue_link, user = {})
+    # Close the issue! (Perhaps using the passed in issue_link url to identify it.)
   end
 
   # The URL for your remote issue tracker
@@ -96,6 +122,8 @@ class MyIssueTracker < ErrbitPlugin::IssueTracker
 end
 ```
 
+
+
 ## Contributing
 
 Discuss any changes you'd like to make with the authors on the mailing list, or

data/lib/errbit_plugin/issue_trackers/none.rb

@@ -23,7 +23,8 @@ module ErrbitPlugin
     def configured?; false; end
     def errors; {}; end
     def url; ''; end
-    def create_issue(*); true; end
+    def create_issue(*); false; end
+    def close_issue(*); false; end
   end
 end
 

data/lib/errbit_plugin/version.rb

@@ -1,3 +1,3 @@
 module ErrbitPlugin
-  VERSION = "0.5.0"
+  VERSION = '0.6.0'
 end

data/spec/errbit_plugin/validate_issue_tracker_spec.rb

@@ -12,6 +12,7 @@ describe ErrbitPlugin::ValidateIssueTracker do
         def configured?; true; end
         def errors; true; end
         def create_issue; 'http'; end
+        def close_issue; 'http'; end
         def url; 'http'; end
       end
 
@@ -30,6 +31,7 @@ describe ErrbitPlugin::ValidateIssueTracker do
         def configured?; true; end
         def errors; true; end
         def create_issue; 'http'; end
+        def close_issue; 'http'; end
         def url; 'http'; end
       end
 
@@ -52,6 +54,7 @@ describe ErrbitPlugin::ValidateIssueTracker do
         def configured?; true; end
         def errors; true; end
         def create_issue; 'http'; end
+        def close_issue; 'http'; end
         def url; 'http'; end
       end
 
@@ -59,7 +62,7 @@ describe ErrbitPlugin::ValidateIssueTracker do
         expect(ErrbitPlugin::ValidateIssueTracker.new(klass).valid?).to be false
       end
 
-      it 'say not implement configured?' do
+      it 'say not implement label method' do
         is = ErrbitPlugin::ValidateIssueTracker.new(klass)
         is.valid?
         expect(is.errors).to eql [[:class_method_missing, :label]]
@@ -74,6 +77,7 @@ describe ErrbitPlugin::ValidateIssueTracker do
         def configured?; true; end
         def errors; true; end
         def create_issue; 'http'; end
+        def close_issue; 'http'; end
         def url; 'http'; end
       end
 
@@ -81,7 +85,7 @@ describe ErrbitPlugin::ValidateIssueTracker do
         expect(ErrbitPlugin::ValidateIssueTracker.new(klass).valid?).to be false
       end
 
-      it 'say not implement configured?' do
+      it 'say not implement icons method' do
         is = ErrbitPlugin::ValidateIssueTracker.new(klass)
         is.valid?
         expect(is.errors).to eql [[:class_method_missing, :icons]]
@@ -96,6 +100,7 @@ describe ErrbitPlugin::ValidateIssueTracker do
         def configured?; true; end
         def errors; true; end
         def create_issue; 'http'; end
+        def close_issue; 'http'; end
         def url; 'http'; end
       end
 
@@ -103,7 +108,7 @@ describe ErrbitPlugin::ValidateIssueTracker do
         expect(ErrbitPlugin::ValidateIssueTracker.new(klass).valid?).to be false
       end
 
-      it 'say not implement configured?' do
+      it 'say not implement fields method' do
         is = ErrbitPlugin::ValidateIssueTracker.new(klass)
         is.valid?
         expect(is.errors).to eql [[:class_method_missing, :fields]]
@@ -118,6 +123,7 @@ describe ErrbitPlugin::ValidateIssueTracker do
         def self.icons; {}; end
         def errors; true; end
         def create_issue; 'http'; end
+        def close_issue; 'http'; end
         def url; 'http'; end
       end
 
@@ -125,7 +131,7 @@ describe ErrbitPlugin::ValidateIssueTracker do
         expect(ErrbitPlugin::ValidateIssueTracker.new(klass).valid?).to be false
       end
 
-      it 'say not implement configured?' do
+      it 'say not implement configured? method' do
         is = ErrbitPlugin::ValidateIssueTracker.new(klass)
         is.valid?
         expect(is.errors).to eql [[:instance_method_missing, :configured?]]
@@ -140,6 +146,7 @@ describe ErrbitPlugin::ValidateIssueTracker do
         def self.icons; {}; end
         def configured?; true; end
         def create_issue; 'http'; end
+        def close_issue; 'http'; end
         def url; 'http'; end
       end
 
@@ -147,7 +154,7 @@ describe ErrbitPlugin::ValidateIssueTracker do
         expect(ErrbitPlugin::ValidateIssueTracker.new(klass).valid?).to be false
       end
 
-      it 'say not implement errors' do
+      it 'say not implement errors method' do
         is = ErrbitPlugin::ValidateIssueTracker.new(klass)
         is.valid?
         expect(is.errors).to eql [[:instance_method_missing, :errors]]
@@ -162,19 +169,43 @@ describe ErrbitPlugin::ValidateIssueTracker do
         def self.icons; {}; end
         def configured?; true; end
         def errors; true; end
+        def close_issue; 'http'; end
         def url; 'http'; end
       end
 
       it 'not valid' do
         expect(ErrbitPlugin::ValidateIssueTracker.new(klass).valid?).to be false
       end
-      it 'say not implement url' do
+      it 'say not implement create_issue method' do
         is = ErrbitPlugin::ValidateIssueTracker.new(klass)
         is.valid?
         expect(is.errors).to eql [[:instance_method_missing, :create_issue]]
       end
     end
 
+    context "without close_issue method" do
+      # this is an optional method
+      klass = Class.new(ErrbitPlugin::IssueTracker) do
+        def self.label; 'foo'; end
+        def self.note; 'foo'; end
+        def self.fields; ['foo']; end
+        def self.icons; {}; end
+        def configured?; true; end
+        def errors; true; end
+        def create_issue; 'http'; end
+        def url; 'http'; end
+      end
+
+      it 'is valid' do
+        expect(ErrbitPlugin::ValidateIssueTracker.new(klass).valid?).to be true
+      end
+      it 'not say not implement close_issue method' do
+        is = ErrbitPlugin::ValidateIssueTracker.new(klass)
+        is.valid?
+        expect(is.errors).not_to eql [[:instance_method_missing, :close_issue]]
+      end
+    end
+
     context "without url method" do
       klass = Class.new(ErrbitPlugin::IssueTracker) do
         def self.label; 'foo'; end
@@ -184,13 +215,14 @@ describe ErrbitPlugin::ValidateIssueTracker do
         def configured?; true; end
         def errors; true; end
         def create_issue; 'http'; end
+        def close_issue; 'http'; end
       end
 
       it 'not valid' do
         expect(ErrbitPlugin::ValidateIssueTracker.new(klass).valid?).to be false
       end
 
-      it 'say not implement url' do
+      it 'say not implement url method' do
         is = ErrbitPlugin::ValidateIssueTracker.new(klass)
         is.valid?
         expect(is.errors).to eql [[:instance_method_missing, :url]]
@@ -205,6 +237,7 @@ describe ErrbitPlugin::ValidateIssueTracker do
         def configured?; true; end
         def errors; true; end
         def create_issue; 'http'; end
+        def close_issue; 'http'; end
         def url; 'foo'; end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: errbit_plugin
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Stephen Crosby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-23 00:00:00.000000000 Z
+date: 2016-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler