virus_total 0.0.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 308097c5810248bccc4c3e783656b80fc22ba05d
-  data.tar.gz: 95daa10ff9a9263248c8c664a63ffbc766af731f
+  metadata.gz: bce4c85fc1ba3ddd93b273d188bd4fb496f80741
+  data.tar.gz: dbfdef518da67d37ac217f41a94f9f55862f5a82
 SHA512:
-  metadata.gz: 19a0ea7eab3ebc523f4e71a78c97487d6e443b382ef676ab192e10f8a537d54a1049fdf9a6ee82d532bacc7d2cef0603515f4cc44b3fa6241104105a864f3622
-  data.tar.gz: 5e74412cd54ccf0471b422f4d0c376cc2cc9a4f1142f4a864570c1443b93a87b475ad5954ce55dddfc9a0e88c5118fb6cb8e52a59d8019823919205f6d878881
+  metadata.gz: 116a92dfe662d13cb56588012545c2d2f6531fb99c68d54256c92ea8ded6e656350f77482d67b19cf0948320f0ac310445ce747a045bb72543ab6f2b067fce8d
+  data.tar.gz: a150d306705ef3cf4f61eb0695b7f6004d7f8f084ae5e2a5abb22cff69caa7d3ded64ab8f504fc854079ec8c4c3b3b95cb83ddcf3cb90720edceb66ec3a4f6b7

data/README.md

@@ -41,34 +41,33 @@ file.report # response from POST "file/report"
 file.rescan # response from POST "file/rescan"
 ```
 
-#### Parse response string
+#### Using response
 ```ruby
 # for example url.report
 response = url.report
-parser = Parser.new(response)
-# <VirusTotal::Parser:0x0000000252eac0 @json_resp={
+# <VirusTotal::Response:0x0000000252eac0 @response={
 # "permalink"=>"https://www.virustotal.com/url/.../",
 # "resource"=>"https://www.example.com",...,
 # "scans"=>{"CLEAN MX"=>{"detected"=>true, "result"=>"clean site"},...}}>
 
-parser.response_code #=> 1: OK, 0: result doesn't exist, -2: still queued
+response.response_code #=> 1: OK, 0: result doesn't exist, -2: still queued
 
 # general info from response
-parser.info          #=> {"permalink"=>"https://www.virustotal.com/url/.../", "resource"=>"..."}
+response.info          #=> {"permalink"=>"https://www.virustotal.com/url/.../", "resource"=>"..."}
 
 # scanning info
-parser.scans         #=> {"CLEAN MX"=>{"detected"=>true, "result"=>"clean site"},...}
+response.scans         #=> {"CLEAN MX"=>{"detected"=>true, "result"=>"clean site"},...}
 
 # information about positive threats
-parser.dangers       #=> {"CLEAN MX"=>{"detected"=>true, "result"=>"clean site"}}
+response.dangers       #=> {"CLEAN MX"=>{"detected"=>true, "result"=>"clean site"}}
 
 # antiviruses which found positive threats
-parser.danger_brands #=> ["CLEAN MX"]
+response.danger_brands #=> ["CLEAN MX"]
 ```
 Also we can get any key/value pair from response hash. If key (it is a string) from response has a whitespaces use underscore between words.
 ```ruby
-parser.scans.CLEAN_MX          #=> {"detected"=>true, "result"=>"clean site"}
-parser.scans.CLEAN_MX.detected #=> true
+response.scans.CLEAN_MX          #=> {"detected"=>true, "result"=>"clean site"}
+response.scans.CLEAN_MX.detected #=> true
 ```
 ### Implemented but not testing yet (needs a private apikey)
 #### Scanning IP-Address
@@ -85,8 +84,13 @@ domain = VirusTotal::Domain.new("example.com", "-- PRIVATE API KEY--")
 
 domain.report # response from GET "domain/report"
 ```
-### Unsupported
-* "comments/puts"
+### Commenting
+```ruby
+# initialize
+comment = VirusTotal::Comment.new("-- Hash of file --", "-- PUBLIC API KEY --")
+
+comment.put "-- Comment text here --"   # post a comment on the resource
+```
 
 ## Contributing
 

data/lib/virus_total.rb

@@ -4,6 +4,7 @@ require "virus_total/url"
 require "virus_total/file"
 require "virus_total/ip"
 require "virus_total/domain"
-require "virus_total/parser"
+require "virus_total/comment"
+require "virus_total/response"
 require "virus_total/exception"
 require "virus_total/version"

data/lib/virus_total/base.rb

@@ -21,7 +21,8 @@ module VirusTotal
       full_url = BASE_URL + url
       params = default_params.merge(params)
 
-      api_request(full_url, params)
+      resp = api_request(full_url, params)
+      Response.new(resp)
     end
 
     private

data/lib/virus_total/comment.rb

@@ -0,0 +1,7 @@
+module VirusTotal
+  class Comment < Base
+    def put(text)
+      api_response('comments/put', resource: resource, comment: text)
+    end
+  end
+end

data/lib/virus_total/domain.rb

@@ -2,7 +2,7 @@ module VirusTotal
   # to use this feature you must have a private apikey!
   class Domain < Base
     def report
-      api_response('domain/report', resource: @resource.to_s, method: :get)
+      api_response('domain/report', resource: resource, method: :get)
     end
   end
 end

data/lib/virus_total/file.rb

@@ -16,7 +16,7 @@ module VirusTotal
 
     def get_file
       tmp = Tempfile.open('tmp')
-      tmp.write(IO::File.read(resource))
+      tmp.write(::File.read(resource))
       tmp
     end
   end

data/lib/virus_total/{parser.rb → response.rb}

@@ -1,7 +1,7 @@
 require 'json'
 
 module VirusTotal
-  class Parser
+  class Response
 
     attr_reader :response
 

data/lib/virus_total/version.rb

@@ -1,3 +1,3 @@
 module VirusTotal
-  VERSION = "0.0.3"
+  VERSION = "0.2.0"
 end

data/solano.yml

@@ -0,0 +1,12 @@
+ruby_version: 1.9.3-p545
+bundler_version: 1.7.8
+
+test_pattern:
+  - spec/**_spec.rb
+
+notify:
+  - channel: email
+    trigger-on: failed
+    branch: master/*
+    message: "Build failed with %error-count% error(s)"
+    recipients: "saychuk.andriy@gmail.com"

data/spec/shared_examples_spec.rb

@@ -1,5 +1,5 @@
 shared_examples_for 'single resource' do
-  let(:response) { JSON.parse(subject) }
+  let(:response) { subject.instance_variable_get("@response") }
 
   it 'should returns correct response' do
     response.should be_a_kind_of(Hash)
@@ -7,7 +7,7 @@ shared_examples_for 'single resource' do
 end
 
 shared_examples_for 'multiply resources' do
-  let(:response) { JSON.parse(subject) }
+  let(:response) { subject.instance_variable_get("@response") }
 
   it 'should returns correct response' do
     response.should be_a_kind_of(Array)

data/spec/virus_total/comment_spec.rb

@@ -0,0 +1,13 @@
+require "virus_total"
+
+describe VirusTotal::Comment do
+  let(:api_key) { "b9f4c087d347d244685fa1ba067b3863"\
+                  "59dd9f46e88558a3f95061e5d4673d5e" }
+  let(:resource) { "da39a3ee5e6b4b0d3255bfef95601890afd80709" }
+  let(:comment) { VirusTotal::Comment.new(resource, api_key) }
+
+  context "for 'comments/put'" do
+    subject { comment.put "This is a test comment" }
+    it_should_behave_like 'single resource'
+  end
+end

data/spec/virus_total/domain_spec.rb

@@ -5,7 +5,7 @@ describe VirusTotal::Domain do
   let(:api_key) { "--YOUR_PRIVATE_KEY--" }
   let(:domain) { VirusTotal::Domain.new("heroku.com", api_key) }
 
-  skip "for single domain" do
+  pending "for single domain" do
     context "for 'domain/report'" do
       subject { domain.report }
       it_should_behave_like 'single resource'

data/spec/virus_total/ip_spec.rb

@@ -5,7 +5,7 @@ describe VirusTotal::Ip do
   let(:api_key) { "--YOUR_PRIVATE_KEY--" }
   let(:ip) { VirusTotal::Ip.new("128.0.0.1", api_key) }
 
-  skip "for single ip address" do
+  pending "for single ip address" do
     context "for 'ip-address/report'" do
       subject { ip.report }
       it_should_behave_like 'single resource'

data/spec/virus_total/{parser_spec.rb → response_spec.rb}

@@ -1,32 +1,32 @@
 require "virus_total"
 
-describe VirusTotal::Parser do
+describe VirusTotal::Response do
   let(:response) {
     "{\"permalink\":\"https://www.virustotal.com/url\","\
     "\"resource\":\"https://www.example.com\","\
     "\"response_code\":1,"\
     "\"scans\":{\"CLEAN MX\":{\"detected\":true}}}"
   }
-  let(:parser) { VirusTotal::Parser.new(response) }
+  let(:response_str) { VirusTotal::Response.new(response) }
 
   it "parse response correctly" do
-    parser.instance_variable_get("@response").should_not be_nil
+    response_str.instance_variable_get("@response").should_not be_nil
   end
 
   it "returns info correctly" do
-    parser.info.should_not match(/scans/)
+    response_str.info.should_not match(/scans/)
   end
 
   it "returns dangers correctly" do
-    parser.dangers.should == {"CLEAN MX"=>{"detected"=>true}}
+    response_str.dangers.should == {"CLEAN MX"=>{"detected"=>true}}
   end
 
   it "returns danger brands correctly" do
-    parser.danger_brands.should == ["CLEAN MX"]
+    response_str.danger_brands.should == ["CLEAN MX"]
   end
 
   it "returns hash value correctly" do
-    parser.response_code.should == 1
+    response_str.response_code.should == 1
   end
 end
 

data/spec/virus_total/url_spec.rb

@@ -32,7 +32,7 @@ describe VirusTotal::Url do
     end
 
     # url/report not working for multiply urls.
-    skip "for 'url/report'" do
+    pending "for 'url/report'" do
       subject { resource.report }
       it_should_behave_like 'multiply resources'
     end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: virus_total
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Rubycop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-15 00:00:00.000000000 Z
+date: 2016-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.6'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.6.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.6.7
 description: gem for VirusTotal API version 2.0.
@@ -73,7 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -81,19 +81,22 @@ files:
 - lib/core_extentions.rb
 - lib/virus_total.rb
 - lib/virus_total/base.rb
+- lib/virus_total/comment.rb
 - lib/virus_total/domain.rb
 - lib/virus_total/exception.rb
 - lib/virus_total/file.rb
 - lib/virus_total/ip.rb
-- lib/virus_total/parser.rb
+- lib/virus_total/response.rb
 - lib/virus_total/url.rb
 - lib/virus_total/version.rb
+- solano.yml
 - spec/shared_examples_spec.rb
 - spec/virus_total/base_spec.rb
+- spec/virus_total/comment_spec.rb
 - spec/virus_total/domain_spec.rb
 - spec/virus_total/file_spec.rb
 - spec/virus_total/ip_spec.rb
-- spec/virus_total/parser_spec.rb
+- spec/virus_total/response_spec.rb
 - spec/virus_total/url_spec.rb
 - virus_total.gemspec
 homepage: https://github.com/rubycop/virus_total
@@ -106,25 +109,26 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: gem for VirusTotal API version 2.0.
 test_files:
 - spec/shared_examples_spec.rb
 - spec/virus_total/base_spec.rb
+- spec/virus_total/comment_spec.rb
 - spec/virus_total/domain_spec.rb
 - spec/virus_total/file_spec.rb
 - spec/virus_total/ip_spec.rb
-- spec/virus_total/parser_spec.rb
+- spec/virus_total/response_spec.rb
 - spec/virus_total/url_spec.rb