jira-ruby-dmg 0.1.20 → 0.1.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5091836e1cd94b8d437b8b90ffd30f240cd9075a
-  data.tar.gz: c2335e7bdc26a6aecdad5494a87587fbf54c1089
+  metadata.gz: 18f7433fcfcb7649f1e731d8a1ddbcb4212a0a18
+  data.tar.gz: 02b14bcdbcd1b9fb4b5bc1bbcd59fab6e18ecf94
 SHA512:
-  metadata.gz: 1b4188f3c85f548a907dfd59e01c282f681ea6fba9d0a0dafbd5776e0afa3de63d1289d711c122ae2fc874a2d411678d0263c246550cc7024a72ac8622e25c33
-  data.tar.gz: cb4b9f8dea064c7a36abadc57a5477ebdd76fe77618d15b7cddabfb0972f926627ae02445719b527b8f55465818549e26bec4a2648113ee9648ba16099620f88
+  metadata.gz: fd2554cc7e779ebb9355e23a34a2ffe9e7f7eece1814f3aad9f55b0ff68d8a9fc835a77a047334808faaa18dd43b8676b514557bb1caf604947cee5bcaa2f713
+  data.tar.gz: 1b7b34c9b5e1640b31c659c687bd8d54bc103c0a47fb64cc55247e3d05a60a2ff0a8161a3dd1d956f6e2a17e1b37c2ef9a2d18137c735f0ebed404a9dc09b88e

data/lib/jira/client.rb

@@ -50,7 +50,9 @@ module JIRA
       :rest_base_path     => "/rest/api/2",
       :ssl_verify_mode    => OpenSSL::SSL::VERIFY_PEER,
       :use_ssl            => true,
-      :auth_type          => :oauth
+      :auth_type          => :oauth,
+      :enable_caching     => false,
+      :cache_ttl          => 86400000 # 1 day
     }
 
     def initialize(options={})
@@ -66,6 +68,8 @@ module JIRA
         @request_client = HttpClient.new(@options)
       end
 
+      @cache = JIRA::RequestCache.new(@options[:cache_ttl])
+
       @options.freeze
     end
 
@@ -133,8 +137,8 @@ module JIRA
       JIRA::Resource::AgileboardFactory.new(self)
     end
 
-    def Velocity # :nodoc:
-      JIRA::Resource::VelocityFactory.new(self)
+    def SprintReport # :nodoc:
+      JIRA::Resource::SprintReportFactory.new(self)
     end
 
     # HTTP methods without a body
@@ -143,9 +147,25 @@ module JIRA
     end
 
     def get(path, headers = {})
-      request(:get, path, nil, merge_default_headers(headers))
+      if @options[:enable_caching]
+        get_from_cache(path, headers)
+      else
+        request(:get, path, nil, merge_default_headers(headers))
+      end
+    end
+
+    def get_from_cache(path, headers)
+      response = @cache.load(path)
+
+      if response == nil
+        response = request(:get, path, nil, merge_default_headers(headers))
+        @cache.save(path, response)
+      end
+
+      response
     end
 
+
     def head(path, headers = {})
       request(:head, path, nil, merge_default_headers(headers))
     end

data/lib/jira/request_cache.rb

@@ -0,0 +1,80 @@
+module JIRA
+
+  class RequestCache
+
+    def initialize(time_to_live)
+      @time_to_live = time_to_live
+    end
+
+    def load(path)
+      key = cache_key(path)
+      cache_object = cache(path)
+      response = verify cache_object[key]
+
+      if response == :expired
+        cache_object.delete(key)
+        cache_file(path, 'w+').write(Marshal.dump(cache_object))
+        nil
+      else
+        response
+      end
+    end
+
+    def save(path, response)
+      now = Time.now.to_i
+
+      new_cache = cache(path)
+      new_cache[cache_key(path)] = {
+        'data' => response,
+        'timestamp' => now
+      }
+
+      cache_file(path, 'w+').write(Marshal.dump(new_cache))
+    end
+
+
+    private
+
+    def verify(cache_value)
+      now = Time.now.to_i
+      #binding.pry
+      if cache_value == nil
+        return nil
+      elsif cache_value['timestamp'] < (now - @time_to_live)
+        :expired
+      else
+        cache_value['data']
+      end
+    end
+
+    def cache(path)
+      #binding.pry
+      if File.exists? 'cache/' + path
+        Marshal.restore(cache_file(path, 'r+').read())
+      else
+        {}
+      end
+    end
+
+    def cache_key(path)
+      return "key"
+      #Marshal.dump(path)
+    end
+
+    def cache_file(path, mode)
+      dir = cache_dir
+      File.new(dir + '/' + path, mode)
+    end
+
+    def cache_dir
+      dir = 'cache'
+      
+      unless Dir.exists? dir
+        FileUtils.mkdir_p(dir)
+      end
+      
+      dir
+    end
+  end
+
+end

data/lib/jira/resource/agileboard.rb

@@ -47,27 +47,6 @@ module JIRA
           client.Sprint.build(sprint)
         end
       end
-
-      # get velocities of agile board
-      def velocities
-        search_url = client.options[:site] + 
-                     '/rest/greenhopper/1.0/rapid/charts/velocity.json?rapidViewId=' + id.to_s
-
-        begin
-          response = client.get(search_url)
-        rescue
-          return []
-        end
-
-        json = self.class.parse_json(response.body)
-        json['velocityStatEntries'].map do |velocity|
-          client.Velocity.build({
-            "sprint_id" => velocity[0],
-            "estimated" => velocity[1]['estimated']['value'],
-            "completed" => velocity[1]['completed']['value']
-          })
-        end
-      end
       
     end
   end

data/lib/jira/resource/sprint.rb

@@ -30,52 +30,20 @@ module JIRA
         end
       end
 
-      def velocity=(velocity)
-        @attrs["velocity"] = velocity
-      end
-
-      def velocity
-        unless attrs.keys.include? "velocity"
-          @attrs["velocity"] = get_velocity
-        end
-
-        @attrs["velocity"]
-      end
-
-      private
-      def get_velocity
-        search_url = client.options[:site] + 
-                     '/rest/greenhopper/1.0/rapid/charts/velocity.json?rapidViewId=' + agileboard_id.to_s
-        begin
-          response = client.get(search_url).body
-        rescue
-          return empty_velocity
+      def sprint_report
+        if @sprint_report
+          return @sprint_report
         end
 
-        json = self.class.parse_json(response)
-        resultVelocity = json['velocityStatEntries'].select do |sprint_id|
-          sprint_id.to_i == id.to_i
-        end
-        
-        if resultVelocity.length == 0
-          return empty_velocity
-        end
+        search_url = client.options[:site] + "/rest/greenhopper/1.0/rapid/charts/sprintreport?rapidViewId=" + 
+                     agileboard_id.to_s + "&sprintId=" + id.to_s
 
-        client.Velocity.build({
-          "sprint_id" => id,
-          "estimated" => resultVelocity[id.to_s]['estimated']['value'],
-          "completed" => resultVelocity[id.to_s]['completed']['value']
-        })
-      end
+        response = client.get(search_url)
+        json = self.class.parse_json(response.body)
 
-      def empty_velocity
-        client.Velocity.build({
-          "sprint_id" => id,
-          "estimated" => 0,
-          "completed" => 0
-        })
+        client.SprintReport.build(json['contents'])
       end
 
     end
   end
-end
+end

data/lib/jira/resource/sprint_report.rb

@@ -0,0 +1,10 @@
+module JIRA
+  module Resource
+
+    class SprintReportFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class SprintReport < JIRA::Base ; end
+
+  end
+end

data/lib/jira/version.rb

@@ -1,3 +1,3 @@
 module JIRA
-  VERSION = "0.1.20"
+  VERSION = "0.1.21"
 end

data/lib/jira.rb

@@ -18,7 +18,7 @@ require 'jira/resource/version'
 require 'jira/resource/status'
 require 'jira/resource/transition'
 require 'jira/resource/filter'
-require 'jira/resource/velocity'
+require 'jira/resource/sprint_report'
 require 'jira/resource/sprint'
 require 'jira/resource/project'
 require 'jira/resource/priority'
@@ -28,6 +28,7 @@ require 'jira/resource/issue'
 require 'jira/resource/field'
 require 'jira/resource/agileboard'
 
+require 'jira/request_cache'
 require 'jira/request_client'
 require 'jira/oauth_client'
 require 'jira/http_client'

data/spec/jira/request_cache_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe JIRA::RequestCache do
+    
+  subject {
+    JIRA::RequestCache.new(86400000)
+  }
+  
+  let(:now) { Time.now.to_i }
+  let(:response) { {"key" => {"data" => "foo", "timestamp" => now}} }
+  let(:test_file) { double("test_file", :read => Marshal.dump(response), :write => nil) }
+  
+  before(:each) do
+    File.stub(:exists?) { true }
+    Dir.stub(:exists?) { true }
+  end
+
+  describe 'load' do
+
+    context "existing cache file" do
+      
+      before(:each) do
+        File.should_receive(:new).with('cache/test_path', 'r+').and_return(test_file)
+      end
+
+      it "should create cache dir if not exists" do
+        Dir.stub(:exists?) { false }
+        FileUtils.should_receive(:mkdir_p).at_least(1).times.with('cache')
+        subject.load('test_path')
+      end
+
+      it "should load from correct path" do
+        subject.load('test_path')
+      end
+
+      it "should return the correct result" do
+        subject.load('test_path').should == 'foo'
+      end
+
+      it "should delete expired entries" do
+        Time.should_receive(:now).and_return(double('now', { :to_i => 572349597437239075456456 }))
+        File.should_receive(:new).with('cache/test_path', 'w+').and_return(test_file)
+        test_file.should_receive(:write).with(Marshal.dump({}))
+
+        subject.load('test_path')
+      end
+    end
+
+    context "without existing cache file" do
+
+      it "should not try to load file if not exists" do
+        File.stub(:exists?) { false }
+        File.should_receive(:new).exactly(0).times
+        subject.load('test_path')
+      end
+
+    end
+  end
+
+  describe 'save' do
+
+    before(:each) do
+      Time.stub(:now) { double({:to_i  => 42}) }
+      File.should_receive(:new).with('cache/test_path', 'r+').and_return(test_file)
+      File.should_receive(:new).with('cache/test_path', 'w+').and_return(test_file)
+    end
+
+    let(:test_response) { 'bar' }
+
+    it "should load from correct path" do
+      subject.save('test_path', test_response)
+    end
+
+    it "should save the correct response" do
+      expected_cache = {"key" => {"data" => test_response, "timestamp" => 42}}
+      test_file.should_receive(:write).with(Marshal.dump(expected_cache))
+
+      subject.save('test_path', test_response)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jira-ruby-dmg
 version: !ruby/object:Gem::Version
-  version: 0.1.20
+  version: 0.1.21
 platform: ruby
 authors:
 - ThisIs! DMG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-26 00:00:00.000000000 Z
+date: 2014-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -118,6 +118,7 @@ files:
 - lib/jira/http_error.rb
 - lib/jira/oauth_client.rb
 - lib/jira/railtie.rb
+- lib/jira/request_cache.rb
 - lib/jira/request_client.rb
 - lib/jira/resource/agileboard.rb
 - lib/jira/resource/attachment.rb
@@ -130,10 +131,10 @@ files:
 - lib/jira/resource/priority.rb
 - lib/jira/resource/project.rb
 - lib/jira/resource/sprint.rb
+- lib/jira/resource/sprint_report.rb
 - lib/jira/resource/status.rb
 - lib/jira/resource/transition.rb
 - lib/jira/resource/user.rb
-- lib/jira/resource/velocity.rb
 - lib/jira/resource/version.rb
 - lib/jira/resource/worklog.rb
 - lib/jira/tasks.rb
@@ -159,6 +160,7 @@ files:
 - spec/jira/http_client_spec.rb
 - spec/jira/http_error_spec.rb
 - spec/jira/oauth_client_spec.rb
+- spec/jira/request_cache_spec.rb
 - spec/jira/request_client_spec.rb
 - spec/jira/resource/attachment_spec.rb
 - spec/jira/resource/filter_spec.rb
@@ -254,6 +256,7 @@ test_files:
 - spec/jira/http_client_spec.rb
 - spec/jira/http_error_spec.rb
 - spec/jira/oauth_client_spec.rb
+- spec/jira/request_cache_spec.rb
 - spec/jira/request_client_spec.rb
 - spec/jira/resource/attachment_spec.rb
 - spec/jira/resource/filter_spec.rb

data/lib/jira/resource/velocity.rb

@@ -1,11 +0,0 @@
-module JIRA
-  module Resource
-
-    class VelocityFactory < JIRA::BaseFactory # :nodoc:
-    end
-
-    class Velocity < JIRA::Base
-    end
-
-  end
-end