nexus_client 0.3.0

data/lib/nexus_client/cache.rb

@@ -0,0 +1,105 @@
+require 'filesize'
+require 'etc'
+
+module Nexus
+  class Cache
+    attr_reader :cache_base, :analytics_enabled
+    attr_accessor :analytics, :log
+
+    def initialize(base_dir='/tmp/cache', enable_analytics=false, logger=nil)
+      @analytics_enabled = enable_analytics
+      @cache_base = base_dir
+      @log = logger
+      create_base
+    end
+
+    def analytics
+      if analytics_enabled
+        if @analytics.nil?
+          begin
+            @analytics = Nexus::Analytics.new(@cache_base, nil, log)
+            if @analytics.nil?
+              @analytics_enabled = false
+              log.warn("Unable to create analytics class, skipping analytics and disabling analytics usage")
+            end
+          rescue
+            log.warn("Unable to create analytics class, skipping analytics and disabling analytics usage")
+            @analytics_enabled = false
+            return @analytics
+          end
+        end
+      end
+      @analytics
+    end
+
+
+    def log
+      if @log.nil?
+        @log = Logger.new(STDOUT)
+      end
+      @log
+    end
+
+    def create_base
+      if not File.exists?(@cache_base)
+        FileUtils.mkdir_p(@cache_base)
+      end
+    end
+
+    def init_cache_info(gav)
+      if gav.attributes[:size].nil?
+        gav.attributes[:size] =  File.size(file_path(gav))
+      end
+      if analytics_enabled
+        analytics.add_item(gav, file_path(gav))
+      end
+    end
+
+    def record_hit(gav)
+      analytics.update_item(gav) if analytics_enabled
+    end
+
+    def add_file(gav, dstfile)
+      if not File.exists?(location(gav))
+        FileUtils.mkdir_p(location(gav))
+      end
+      if File.exists?(dstfile)
+        FileUtils.copy(dstfile, file_path(gav))
+        init_cache_info(gav)
+      else
+        log.warn "file #{dstfile } will not be cached as it doesn't exist"
+      end
+
+    end
+
+    # location is the directory where the files should be cached
+    def location(gav)
+      File.join(cache_base, gav.dir_location)
+    end
+
+    # the file path of the gav, the name of the file is the <sha1>.cache
+    def file_path(gav)
+      if gav.sha1.nil?
+        raise('Need sha1 for gav')
+      end
+      File.join(location(gav), "#{gav.sha1}.cache")
+    end
+
+    # is_cached? returns a bool true if the file is cached
+    # the sha1 checksum should be the file name and if it exists, it means its cached
+    def exists?(gav)
+      file = file_path(gav)
+      File.exists?(file)
+    end
+
+    # the fastest way to prune this is to use the local find command
+    def prune_cache(mtime=15)
+      # get old, unused entries and discard from DB and filesystem
+      entries = remove_old_items(mtime)
+      entries.each do |key, entry|
+        FileUtils.rm_f(entry[:file])
+      end
+    end
+
+  end
+end

data/lib/nexus_client/gav.rb

@@ -0,0 +1,44 @@
+module Nexus
+  class Gav
+    attr_accessor :group, :artifact, :version, :repo, :classifier, :extension, :sha1, :attributes
+    attr_reader :gav_value
+
+    def initialize(gav_string)
+      raise(err) if gav_match.match(gav_string).nil?
+      @group,@artifact,@version,@repo,@classifier,@extension = gav_string.split(":")
+      @gav_value = gav_string
+      @attributes = {}
+    end
+
+    def to_s
+      gav_value
+    end
+
+    def filename
+      if classifier.empty?
+        "#{artifact}-#{version}.#{extension}"
+      else
+        "#{artifact}-#{version}-#{classifier}.#{extension}"
+      end
+    end
+
+    def to_hash
+      {:g => group, :a => artifact, :v => version, :r => repo, :c => classifier, :e => extension}
+    end
+
+    # returns a directory location given the gav ie. /org/glassfish/main/external/ant/
+    def dir_location
+      File.join(group.gsub('.', '/'), artifact)
+    end
+
+    private
+    def gav_match
+      /([\w\.\-]+:[\w\.\-]+:[\.\w\-]+:[\w\.\-]*:[\w\.\-]*:[\w\.\-]*)/
+    end
+
+    def err
+      'Must provide gav_str in the form of "<group>:<artifact>:<version>:<repo>:<classifier>:<extension>"'
+    end
+
+  end
+end

data/lib/nexus_client/version.rb

@@ -0,0 +1,9 @@
+module Nexus
+  class Client
+    VERSION = "0.3.0"
+
+    def self.version
+      VERSION
+    end
+  end
+end

data/nexus_client.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nexus_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nexus_client"
+  spec.version       = Nexus::Client::VERSION
+  spec.authors       = ["Jason Thigpen", "Corey Osman"]
+  spec.email         = ["darwin@senet.us", "corey@logicminds.biz"]
+  spec.description   = %q{Simple Ruby client for dealing with Nexus}
+  spec.summary       = %q{Simple Nexus Ruby Client}
+  spec.homepage      = "https://github.com/logicminds/nexus-client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.add_runtime_dependency "trollop", "= 2.0"
+  spec.add_runtime_dependency "json" if Gem.ruby_version < Gem::Version.new('2.0')
+  spec.add_runtime_dependency "typhoeus", "= 0.6.9"
+  spec.add_runtime_dependency "filesize", "= 0.0.3"
+  spec.add_development_dependency "sqlite3", '~> 1.3'
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", "~> 2.99"
+  spec.add_development_dependency "fakefs", "= 0.5"
+
+end

data/spec/integration/analytics_spec.rb

@@ -0,0 +1,137 @@
+require "spec_helper"
+require 'sqlite3'
+
+describe "Integration Nexus::Analytics" do
+  before(:all) do
+    FileUtils.mkdir_p('/tmp/cache') if not File.exists?('/tmp/cache')
+  end
+  file = '/tmp/ant-4.0.pom'
+  shafile = '/tmp/ant-4.0.pom.sha1'
+
+  after(:all) do
+    FileUtils.rm(file) if File.exists?(file)
+    FileUtils.rm_rf('/tmp/cache/analytics.db')
+
+  end
+  before(:each) do
+    FileUtils.rm_rf('/tmp/cache/analytics.db') if File.exists?('/tmp/cache/analytics.db')
+    @gav = Nexus::Gav.new('org.glassfish.main.external:ant:4.0:central::pom')
+    @gav.sha1 = '387951c0aa333024b25085d76a8ad77441b9e55f'
+    @gav.attributes[:total_time] = 0.332
+    @gav.attributes[:size] = 123837
+    @gav2 = Nexus::Gav.new('org.apache.maven:maven:3.2.1:central::pom')
+    @gav2.sha1 = '54af5be0a5677e896e9eaa356bbb82abda06bd76'
+    @gav2.attributes[:total_time] = 0.532
+    @gav2.attributes[:size] = 12389
+    @analytics = Nexus::Analytics.new('/tmp/cache', 'analytics.db')
+  end
+
+  it 'db exists' do
+    expect(File.exists?('/tmp/cache/analytics.db')).to be_true
+  end
+
+  it 'table exists' do
+   expect(@analytics.db.execute("select * from artifacts")).to eq([])
+  end
+
+  it 'gavs return' do
+    @analytics.add_item(@gav, '/tmp/cache/org/glassfish/main/external/ant/387951c0aa333024b25085d76a8ad77441b9e55f.cache')
+    expect(@analytics.gavs.length).to eq(1)
+  end
+
+  it 'total view exists' do
+    @analytics.add_item(@gav, '/tmp/cache/org/glassfish/main/external/ant/387951c0aa333024b25085d76a8ad77441b9e55f.cache')
+    @analytics.update_item(@gav)
+    @analytics.update_item(@gav)
+    @analytics.update_item(@gav)
+    @analytics.update_item(@gav)
+    expected = [["896f6a67964939a62f6b29e3d6fa13139ee92f9a",
+                 "org.glassfish.main.external:ant:4.0:central::pom",
+                 123837, 0.332, "2014-06-11 00:44:07 -0700",
+                 "/tmp/cache/org/glassfish/main/external/ant/387951c0aa333024b25085d76a8ad77441b9e55f.cache",
+                 4, 495348, 1.328]]
+    expect(@analytics.db.execute("select * from totals").length).to eq(1)
+  end
+
+  it '#old_items' do
+    @analytics.add_item(@gav, '/tmp/cache/org/glassfish/main/external/ant/387951c0aa333024b25085d76a8ad77441b9e55f.cache')
+    expect(@analytics.old_items((Time.now + 10000).to_i).length).to eq(1)
+    expect(@analytics.old_items((Time.now - 10000).to_i).length).to eq(0)
+
+  end
+
+  it '#remove_old_items' do
+    @analytics.add_item(@gav, '/tmp/cache/org/glassfish/main/external/ant/387951c0aa333024b25085d76a8ad77441b9e55f.cache')
+    expect(@analytics.old_items((Time.now + 10000).to_i).length).to eq(1)
+    @analytics.remove_old_items((Time.now + 10000).to_i)
+    expect(@analytics.old_items((Time.now + 10000).to_i).length).to eq(0)
+  end
+
+  it 'top works' do
+    @analytics.add_item(@gav, '/tmp/cache/org/glassfish/main/external/ant/387951c0aa333024b25085d76a8ad77441b9e55f.cache')
+    @analytics.update_item(@gav)
+    @analytics.update_item(@gav)
+    @analytics.update_item(@gav)
+    @analytics.update_item(@gav)
+    expected = [["896f6a67964939a62f6b29e3d6fa13139ee92f9a",
+                 "org.glassfish.main.external:ant:4.0:central::pom",
+                 123837, 0.332, "2014-06-11 00:44:07 -0700",
+                 "/tmp/cache/org/glassfish/main/external/ant/387951c0aa333024b25085d76a8ad77441b9e55f.cache",
+                 4, 495348, 1.328]]
+    expect(@analytics.top_x(3).length).to eq(1)
+  end
+
+  it 'can add item' do
+    @analytics.add_item(@gav, '/tmp/cache/org/glassfish/main/external/ant/387951c0aa333024b25085d76a8ad77441b9e55f.cache')
+    @analytics.add_item(@gav2, '/tmp/cache/org/apache/maven/54af5be0a5677e896e9eaa356bbb82abda06bd76.cache')
+    expect(@analytics.db.execute("select * from artifacts")).to be_a Array
+  end
+
+  it 'should not error out when duplicate item is added' do
+    expect{@analytics.add_item(@gav, '/tmp/cache/org/glassfish/main/external/ant/387951c0aa333024b25085d76a8ad77441b9e55f.cache')}.to_not raise_error
+    expect{@analytics.add_item(@gav, '/tmp/cache/org/glassfish/main/external/ant/387951c0aa333024b25085d76a8ad77441b9e55f.cache')}.to_not raise_error
+
+  end
+
+  it 'can update item' do
+    expect{@analytics.add_item(@gav, '/tmp/cache/org/glassfish/main/external/ant/387951c0aa333024b25085d76a8ad77441b9e55f.cache')}.to_not raise_error
+    @analytics.update_item(@gav)
+    @analytics.update_item(@gav)
+    expect(@analytics.hit_count(@gav)).to eq(2)
+
+  end
+
+  it '#totals_bytes with pretty' do
+    expect{@analytics.add_item(@gav, '/tmp/cache/org/glassfish/main/external/ant/387951c0aa333024b25085d76a8ad77441b9e55f.cache')}.to_not raise_error
+    @analytics.update_item(@gav)
+    @analytics.update_item(@gav)
+    expect(@analytics.total_bytes(@gav, true)).to eq('241.87 kiB')
+  end
+
+  it '#totals_bytes without pretty' do
+    expect{@analytics.add_item(@gav, '/tmp/cache/org/glassfish/main/external/ant/387951c0aa333024b25085d76a8ad77441b9e55f.cache')}.to_not raise_error
+    @analytics.update_item(@gav)
+    @analytics.update_item(@gav)
+    expect(@analytics.total_bytes(@gav)).to eq(247674)
+  end
+
+  it '#totals_time' do
+    expect{@analytics.add_item(@gav, '/tmp/cache/org/glassfish/main/external/ant/387951c0aa333024b25085d76a8ad77441b9e55f.cache')}.to_not raise_error
+    @analytics.update_item(@gav)
+    @analytics.update_item(@gav)
+    expect(@analytics.total_time(@gav)).to eq(0.664)
+  end
+
+  it '#to_json' do
+    @analytics.add_item(@gav, '/tmp/cache/org/glassfish/main/external/ant/387951c0aa333024b25085d76a8ad77441b9e55f.cache')
+    @analytics.update_item(@gav)
+    @analytics.update_item(@gav)
+    @analytics.update_item(@gav)
+    @analytics.update_item(@gav)
+    @analytics.update_item(@gav)
+    data = JSON.parse(@analytics.to_json)
+
+    expect(data).to be_a(Array)
+  end
+
+end

data/spec/integration/cache_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+
+describe "Integration Nexus::Cache" do
+  gav_str = 'org.glassfish.main.external:ant:4.0:central::pom'
+  gav_str2 = 'org.apache.maven:maven:3.2.1:central::pom'
+  after(:all) do
+
+  end
+
+  before(:each) do
+     let(:gav) do
+       Nexus::Gav.new(gav_str)
+     end
+     let(:gav2) do
+       Nexus::Gav.new(gav_str2)
+     end
+     gav2.sha1 = '387951c0aa333024b25085d76a8ad77441b9e55f'
+     gav1.sha1 = ''
+  end
+
+  context 'turn analytics on' do
+    let(:cache) do
+      Nexus::Cache.new('/tmp/cache', true)
+    end
+  end
+
+  context 'turn analytics off' do
+    let(:cache) do
+      Nexus::Cache.new('/tmp/cache', false)
+    end
+
+    gav2 = Nexus::Gav.new(gav_str)
+    gav2.sha1 = '387951c0aa333024b25085d76a8ad77441b9e55f'
+
+  end
+
+end

data/spec/integration/nexus_client_spec.rb

@@ -0,0 +1,76 @@
+require "spec_helper"
+
+describe 'Integration Nexus::Client' do
+
+  file = '/tmp/ant-4.0.pom'
+  shafile = '/tmp/ant-4.0.pom.sha1'
+
+  after(:all) do
+    FileUtils.rm(file) if File.exists?(file)
+    FileUtils.rm(shafile) if File.exists?(shafile)
+
+    FileUtils.rm_rf('/tmp/cache')  if File.exists?('/tmp/cache')
+  end
+
+  subject(:client) { Nexus::Client.new('https://repository.jboss.org/nexus','/tmp/cache') }
+
+  let(:gav) do
+    Nexus::Gav.new('org.glassfish.main.external:ant:4.0:central::pom')
+  end
+
+
+  it 'can read sha1 gav data' do
+    expect(client.gav_data(gav)['sha1']).to eq('387951c0aa333024b25085d76a8ad77441b9e55f')
+  end
+  it 'can download using Class method' do
+    expect(Nexus::Client.download('/tmp',gav.to_s,'/tmp/cache', true, true,'https://repository.jboss.org/nexus') == true)
+    expect(File.exists?(file) == true )
+  end
+
+  it 'cache on' do
+    expect(Nexus::Client.download('/tmp',gav.to_s,'/tmp/cache', true, true,'https://repository.jboss.org/nexus') == true )
+    expect(File.exists?(file)).to be_true
+    expect(File.exists?('/tmp/cache/org/glassfish/main/external/ant/387951c0aa333024b25085d76a8ad77441b9e55f.cache')).to be_true
+
+  end
+
+  # it 'cache analytics file is created' do
+  #   FileUtils.rm(file)
+  #   FileUtils.rm_rf('/tmp/cache')
+  #   expect(client.download_gav('/tmp',gav.to_s) == true )
+  #   expect(File.exists?('/tmp/cache/cache_analytics.json') == true )
+  #   cache = client.cache
+  #  # expect(cache.analytics['896f6a67964939a62f6b29e3d6fa13139ee92f9a']['time_saved']).to eq(0)
+  #  # expect(cache.analytics['896f6a67964939a62f6b29e3d6fa13139ee92f9a']['bandwidth_saved']).to eq('0 B')
+  # end
+
+  # it 'cache analytics file is populated correctly' do
+  #   FileUtils.rm(file)
+  #   FileUtils.rm_rf('/tmp/cache')
+  #   n_client = Nexus::Client.new(nil,'/tmp/cache')
+  #   n_client.download_gav('/tmp',gav.to_s)
+  #   bytes = n_client.cache.analytics['896f6a67964939a62f6b29e3d6fa13139ee92f9a']['size']
+  #   bytes = Filesize.from(bytes).to_i
+  #   time =  n_client.cache.analytics['896f6a67964939a62f6b29e3d6fa13139ee92f9a']['total_time_secs']
+  #   (0..10).each do | num |
+  #     n_client.download_gav('/tmp',gav.to_s)
+  #     cache = n_client.cache.analytics['896f6a67964939a62f6b29e3d6fa13139ee92f9a']
+  #     expect(cache['hit_count']).to eq(num)
+  #     #expect(cache['time_saved']).to eq(time * num)   # errors out due to rounding error
+  #     #expect(Filesize.from(cache['bandwidth_saved']).to_i).to eq((num * bytes ))
+  #     FileUtils.rm(file)
+  #   end
+  #
+  # end
+
+  it 'cache off' do
+    FileUtils.rm(file)  if File.exists?(file)
+    FileUtils.rm_rf('/tmp/cache/com')
+    expect(Nexus::Client.download('/tmp',gav.to_s,'/tmp/cache', false,false,'https://repository.jboss.org/nexus') == true)
+    expect(File.exists?(file) == true )
+    expect(File.exists?('/tmp/cache/org/glassfish/main/external/ant/*.cache') == false )
+
+  end
+
+end
+