tigre-client 0.2.9 → 0.3.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tigre-client (0.2.8)
+    tigre-client (0.2.9)
       faraday (~> 0.6.0)
 
 GEM

data/lib/tigre-client/common_params.rb

@@ -0,0 +1,33 @@
+module Tigre
+  module CommonParams
+        
+    def common_params(params)
+      @page = params[:page] ||= 0
+      @per  = params[:per]  ||= 50
+      
+      if params[:after]
+        if params[:after].is_a?(Time)
+          @after = params[:after].to_i
+        else
+          @after = params[:after]
+        end
+      end
+      if params[:before] 
+        if params[:before].is_a?(Time)
+          @before = params[:before].to_i
+        else
+          @before = params[:before]
+        end
+      end
+    end
+    
+    def package_array_list(list)
+      if list.is_a?(Array)
+        list.map {|m| m.strip}.join(',') 
+      else
+        list.split(',').map {|m| m.strip}.join(',')
+      end
+    end
+    
+  end
+end

data/lib/tigre-client/sample.rb

@@ -1,6 +1,8 @@
 module Tigre
   class Sample
-
+    
+    extend Tigre::CommonParams
+    
     # required params
     #   file_location => String path to the file
     #   md5 => String
@@ -14,13 +16,7 @@ module Tigre
         raise ArguementError, "File_location or md5 parameter cannot be empty"
       end
       
-      if options[:tags]
-        if options[:tags].is_a?(Array)
-          options[:tags] = options[:tags].map {|t| t.strip}.join(',') 
-        else
-          options[:tags] = options[:tags].split(',').map {|t| t.strip}.join(',')
-        end
-      end
+      options[:tags] = package_array_list(options[:tags]) if options[:tags]
       
       post_data = {:file => File.new(file_location), :md5 => md5}
       Tigre.post_file_connection('/samples', post_data.merge(options))
@@ -31,9 +27,8 @@ module Tigre
     #     :page => Integer, :default => 0
     #     :per => Integer, :default => 50
     def self.index(options={})
-      options[:page] ||= 0
-      options[:per]  ||= 50
-      Tigre.get_connection("/samples?page=#{options[:page]}&per=#{options[:per]}")
+      common_params(options)
+      Tigre.get_connection("/samples?page=#{@page}&per=#{@per}")
     end
     
     # required params
@@ -44,22 +39,44 @@ module Tigre
       Tigre.put_connection("/samples/#{md5}", update_data)
     end
     
+    def self.get(params_hash)
+      unless params_hash[:digest] && params_hash[:value]
+        raise 'Missing parameter :digest or :value'
+      end
+
+      Tigre.get_connection("/samples/#{params_hash[:digest]}/value/#{params_hash[:value]}")
+    end
+    
+    ##
+    #  DEPRECATED => use Tigre::Sample.get(:digest => 'md5', :value => 'your-md5')
+    #
     # required params
     #   md5 => String
     def self.md5(md5)
-      Tigre.get_connection("/samples/md5/#{md5}")
+      Tigre.logger.warn "** DEPRECATED ** Use Tigre::Sample.get(:digest => 'md5', :value => 'your-md5')" if Tigre.logger
+      self.get(:digest => 'md5', :value => md5)
     end
     
+    ##
+    #  DEPRECATED => use Tigre::Sample.get(:digest => 'sha1', :value => 'your-sha1')
+    #
     # required params
     #   sha1 => String
     def self.sha1(sha1)
-      Tigre.get_connection("/samples/sha1/#{sha1}")
+      Tigre.logger.warn "** DEPRECATED ** Use Tigre::Sample.get(:digest => 'sha1', :value => 'your-sha1')" if Tigre.logger
+      params_hash = {:digest => 'sha1', :value => sha1}
+      self.get(params_hash)
     end
     
+    ##
+    #  DEPRECATED => use Tigre::Sample.get(:digest => 'sha256', :value => 'your-sha256')
+    #
     # required params
     #   sha256 => String
     def self.sha256(sha256)
-      Tigre.get_connection("/samples/sha256/#{sha256}")
+      Tigre.logger.warn "** DEPRECATED ** Use Tigre::Sample.get(:digest => 'sha256', :value => 'your-sha256')" if Tigre.logger
+      params_hash = {:digest => 'sha256', :value => sha256}
+      self.get(params_hash)
     end
         
     # required params
@@ -72,18 +89,12 @@ module Tigre
     #     :per => Integer, :default => 50
     def self.tagged_with(tags, options={})
       if tags == ''
-        raise ArguementError, "Missing tags parameter"
-      end
-      
-      if tags.is_a?(Array)
-        tags = tags.map {|t| t.strip}.join(',') 
-      else
-        tags = tags.split(',').map {|t| t.strip}.join(',')
+        raise "Missing tags parameter"
       end
-            
-      options[:page] ||= 0
-      options[:per]  ||= 50
-      Tigre.get_connection("/samples/tagged_with?tags=#{tags}&page=#{options[:page]}&per=#{options[:per]}")
+
+      common_params(options)
+      tags = package_array_list(tags)
+      Tigre.get_connection("/samples/tagged_with?tags=#{tags}&page=#{@page}&per=#{@per}")
     end
     
     # required
@@ -96,13 +107,7 @@ module Tigre
         raise ArguementError, "Missing tags parameter"
       end
       
-      if tags.is_a?(Array)
-        tags = tags.map {|t| t.strip}.join(',') 
-      else
-        tags = tags.split(',').map {|t| t.strip}.join(',')
-      end
-      update_data = {"tag_list" => tags}
-
+      update_data = {"tag_list" => package_array_list(tags)}
       Tigre.put_connection("/samples/#{md5}/add_tags", update_data)
     end
 
@@ -116,15 +121,57 @@ module Tigre
       unless hash[:digest] && hash[:value] && hash[:tag_list]
         raise 'Missing parameter :digest or :value or :tag_list'
       end
+
+      update_data = {"tag_list" => package_array_list(hash[:tag_list])}
+      Tigre.put_connection("/samples/#{hash[:digest]}/value/#{hash[:value]}/remove_tags", update_data)
+    end
+
+    # required params
+    #   tags => String => I.E 'foo'
+    #   tags => String (comma seperated) => I.E 'foo,bar,baz'
+    #   tags => Array => ['foo', 'bar', 'baz']
+    # optional params
+    #   options => Hash
+    #     :page => Integer, :default => 0
+    #     :per => Integer, :default => 50
+    def self.has_mime_type(mime_types, options={})
+      if mime_types == ''
+        raise "Missing tags parameter"
+      end
       
-      if hash[:tag_list].is_a?(Array)
-        hash[:tag_list] = hash[:tag_list].map {|t| t.strip}.join(',') 
-      else
-        hash[:tag_list] = hash[:tag_list].split(',').map {|t| t.strip}.join(',')
+      common_params(options)
+      mime_types = package_array_list(mime_types)
+      Tigre.get_connection("/samples/has_mime_type?mime_types=#{mime_types}&page=#{@page}&per=#{@per}")
+    end
+    
+    # required params
+    #   hash   => Hash
+    #     :digest => String,  The digest type
+    #     :value  => String,  The digest value
+    #     :mime_type_list => String (comma seperated) => I.E 'foo,bar,baz'
+    #     :mime_type_list => Array => ['foo', 'bar', 'baz'] 
+    def self.add_mime_type(hash)
+      unless hash[:digest] && hash[:value] && hash[:mime_type_list]
+        raise 'Missing parameter :digest or :value or :mime_type_list'
       end
 
-      update_data = {"tag_list" => hash[:tag_list]}
-      Tigre.put_connection("/samples/#{hash[:digest]}/value/#{hash[:value]}/remove_tags", update_data)      
+      update_data = {"mime_types" => package_array_list(hash[:mime_type_list])}
+      Tigre.put_connection("/samples/#{hash[:digest]}/value/#{hash[:value]}/add_mime_types", update_data)
+    end
+
+    # required params
+    #   hash   => Hash
+    #     :digest => String,  The digest type
+    #     :value  => String,  The digest value
+    #     :mime_type_list => String (comma seperated) => I.E 'foo,bar,baz'
+    #     :mime_type_list => Array => ['foo', 'bar', 'baz']
+    def self.remove_mime_type(hash)
+      unless hash[:digest] && hash[:value] && hash[:mime_type_list]
+        raise 'Missing parameter :digest or :value or :mime_type_list'
+      end
+      
+      update_data = {"mime_types" => package_array_list(hash[:mime_type_list])}
+      Tigre.put_connection("/samples/#{hash[:digest]}/value/#{hash[:value]}/remove_mime_types", update_data)      
     end
 
   end

data/lib/tigre-client/url.rb

@@ -1,25 +1,7 @@
 module Tigre
   class Url
-
-    def self.common_params(params)
-      @page = params[:page] ||= 0
-      @per  = params[:per]  ||= 50
-      
-      if params[:after]
-        if params[:after].is_a?(Time)
-          @after = params[:after].to_i
-        else
-          @after = params[:after]
-        end
-      end
-      if params[:before] 
-        if params[:before].is_a?(Time)
-          @before = params[:before].to_i
-        else
-          @before = params[:before]
-        end
-      end
-    end
+    
+    extend Tigre::CommonParams
 
     # required params
     #   url => String
@@ -28,12 +10,15 @@ module Tigre
     # optional params
     #   options => Hash
     #     :shareable => Boolean, :default => false
+    #     :tags => String => I.E 'foo'
+    #     :tags => String (comma seperated) => I.E 'foo,bar,baz'
+    #     :tags => Array => ['foo', 'bar', 'baz']
     def self.post(url, options={})
       if url == ''
-        raise ArguementError, "Missing url parameter"
+        raise  "Missing url parameter"
       end
       unless options[:source_name]
-        raise ArguementError, "Missing source_name parameter"
+        raise "Missing source_name parameter"
       end
 
       # prepare post data
@@ -43,14 +28,8 @@ module Tigre
         "url[shareable]"    => options[:shareable],
       }
       
-      if options[:tags]
-        if options[:tags].is_a?(Array)
-          post_data["url[tags]"] = options[:tags].map {|t| t.strip}.join(',') 
-        else
-          post_data["url[tags]"] = options[:tags].split(',').map {|t| t.strip}.join(',')
-        end
-      end
-      
+      post_data["url[tags]"] = package_array_list(options[:tags]) if options[:tags]
+
       Tigre.post_connection('/urls', post_data)
     end
 
@@ -59,7 +38,7 @@ module Tigre
     #   params_hash => Hash
     def self.update(sha256, params_hash)
       if sha256 == '' || params_hash.empty?
-        raise ArguementError, "Missing url parameter or params_hash is empty"
+        raise "Missing url parameter or params_hash is empty"
       end
 
       update_data = params_hash.map { |k, v| {"url[#{k.to_s}]" => v.to_s} }
@@ -70,18 +49,13 @@ module Tigre
     #   sha256 => String
     #   tags => String => I.E 'foo'
     #   tags => String (comma seperated) => I.E 'foo,bar,baz'
-    #   tags => Array => ['foo', 'bar', 'baz']    
+    #   tags => Array => ['foo', 'bar', 'baz']
     def self.add_tags(sha256, tags)
       if sha256 == '' || tags == '' 
         raise ArguementError, "Missing tags parameter"
       end
-      
-      if tags.is_a?(Array)
-        tags = tags.map {|t| t.strip}.join(',') 
-      else
-        tags = tags.split(',').map {|t| t.strip}.join(',')
-      end
-      update_data = {"tag_list" => tags}
+
+      update_data = {"tag_list" => package_array_list(tags)}
 
       Tigre.put_connection("/urls/#{sha256}/add_tags", update_data)
     end
@@ -133,7 +107,7 @@ module Tigre
         raise ArguementError, "Missing proper parameters (:start_date or :end_date required)"
       end
 
-      self.common_params(options)
+      common_params(options)
 
       Tigre.get_connection("/urls/daterange?after=#{@after}&before=#{@before}&page=#{@page}&per=#{@per}")
     end
@@ -151,16 +125,17 @@ module Tigre
         raise ArguementError, "Missing domain parameter"
       end
 
-      if options[:after] && options[:after].is_a?(Time)
-        options[:after] = options[:after].to_i
-      end
-      if options[:before] && options[:before].is_a?(Time)
-        options[:before] = options[:before].to_i
-      end
-
-      options[:page] ||= 0
-      options[:per]  ||= 50
-      Tigre.get_connection("/urls/domains?domain=#{domain}&after=#{options[:after]}&before=#{options[:before]}&page=#{options[:page]}&per=#{options[:per]}")
+      # if options[:after] && options[:after].is_a?(Time)
+      #   options[:after] = options[:after].to_i
+      # end
+      # if options[:before] && options[:before].is_a?(Time)
+      #   options[:before] = options[:before].to_i
+      # end
+      # 
+      # options[:page] ||= 0
+      # options[:per]  ||= 50
+      common_params(options)
+      Tigre.get_connection("/urls/domains?domain=#{domain}&after=#{@after}&before=#{@before}&page=#{@page}&per=#{@per}")
     end
     
     # required params
@@ -178,14 +153,8 @@ module Tigre
         raise "Missing tags parameter"
       end
       
-      if tags.is_a?(Array)
-        tags = tags.map {|t| t.strip}.join(',') 
-      else
-        tags = tags.split(',').map {|t| t.strip}.join(',')
-      end
-      
-      self.common_params(options)
-      
+      tags = package_array_list(tags)
+      common_params(options)
       Tigre.get_connection("/urls/tagged_with?tags=#{tags}&after=#{@after}&before=#{@before}&page=#{@page}&per=#{@per}")
     end
     
@@ -200,13 +169,7 @@ module Tigre
         raise 'Missing parameter :digest or :value or :tag_list'
       end
       
-      if hash[:tag_list].is_a?(Array)
-        hash[:tag_list] = hash[:tag_list].map {|t| t.strip}.join(',') 
-      else
-        hash[:tag_list] = hash[:tag_list].split(',').map {|t| t.strip}.join(',')
-      end
-
-      update_data = {"tag_list" => hash[:tag_list]}
+      update_data = {"tag_list" => package_array_list(hash[:tag_list])}
       Tigre.put_connection("/urls/#{hash[:digest]}/value/#{hash[:value]}/remove_tags", update_data)      
     end
     

data/lib/tigre-client/version.rb

@@ -1,5 +1,5 @@
 module Tigre
   module Client
-    VERSION = "0.2.9"
+    VERSION = "0.3.0"
   end
 end

data/lib/tigre-client.rb

@@ -2,6 +2,7 @@ require 'faraday'
 
 require 'tigre-client/multipart_with_file'
 
+require 'tigre-client/common_params'
 require 'tigre-client/occurrence'
 require 'tigre-client/sample'
 require 'tigre-client/url'

metadata

@@ -2,7 +2,7 @@
 name: tigre-client
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.9
+  version: 0.3.0
 platform: ruby
 authors: 
 - Marcio Castilho
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-20 00:00:00 -04:00
+date: 2011-04-25 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -53,6 +53,7 @@ files:
 - Gemfile.lock
 - Rakefile
 - lib/tigre-client.rb
+- lib/tigre-client/common_params.rb
 - lib/tigre-client/multipart_with_file.rb
 - lib/tigre-client/occurrence.rb
 - lib/tigre-client/sample.rb