a_parser_client 0.1.6 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ce1ab499b36e7ca18f90688137769f8a4dc153a1b7c6ffc683ec967fda1c6ff
-  data.tar.gz: 21f8cb0c7fab8275665471654c6fa9a1029412f37a236455fec9aa20951ef651
+  metadata.gz: bb17cbf3c7f7242c9b4b59029f9e0b4cc1b5f69d0232047cf9876a78f654579d
+  data.tar.gz: ef2ab37b08492563235b4fd80de9462f86c684b4cea8d42da1daea17c5643bc0
 SHA512:
-  metadata.gz: 40deb64d676410e4c1bfc35c33078eb589855459378456806f3e7d3b07c1db47e53b4a9d6dd43a1be70512bc671b538ad25c4eb16a265f31d44d555b8a0181ed
-  data.tar.gz: 3280913d3d3afad37c3132074a015704de50e89bc9ed2f78e3905f86e073c9173f199fcdcfbdb7aeacbcb50784f69eebd03b793c08d1d37887b75ccf487d7574
+  metadata.gz: 67e35c398c10bbf1016b9c204f8dd5a71568442b9a9abd023c1da0af5f8882c9a7fb5ec59c1f16123855f74b705f3352757e8f92a137b9483fa298bfa50e72c6
+  data.tar.gz: 19c44de33e962c58597eb226584ae4e19cf2be134d82263f021592ca6301b85de32d408b971494e6fe9b87a91a8f82fd4da61f0880e64665e953a7c16d69eef5

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    a_parser_client (0.1.6)
+    a_parser_client (0.1.12)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.3)
-    rake (10.5.0)
+    rake (13.0.1)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -28,8 +28,8 @@ PLATFORMS
 DEPENDENCIES
   a_parser_client!
   bundler (~> 2.0)
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.0.2
+   2.2.6

data/README.md

@@ -8,27 +8,29 @@ This is a test release, more API coverage is upcoming.
 
 Covered for now:
 
-	-	ping
-	-	info
-	- 	getTaskList
-	-	getTaskState
-	-	getTaskConf
-	-	addTask
-	-	changeTaskStatus
-	-	getAccountsCount	
-	-	getProxies	
-	-	update	
-	-	getTaskResultsFile	
-	-	deleteTaskResultsFile	
-	-	moveTask	
-	-	getParserInfo	
-	-	getParserPreset	
+-	ping
+-	info
+- 	getTaskList
+-	getTaskState
+-	getTaskConf
+-	addTask
+-	changeTaskStatus
+-	getAccountsCount	
+-	getProxies	
+-	update	
+-	getTaskResultsFile	
+-	deleteTaskResultsFile	
+-	moveTask	
+-	getParserInfo	
+-	getParserPreset	
+-	oneRequest
+-	bulkRequest
 
 TODO:
 
-	-	oneRequest
-	-	bulkRequest
+Some automation procedures:
 
+-	multitasks operations (like stop all tasks etc.)
 
 
 ## Installation

data/a_parser_client.gemspec

@@ -29,6 +29,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/bin/console

@@ -1,14 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "a_parser_client"
+require 'bundler/setup'
+require 'a_parser_client'
 
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/a_parser_client.rb

@@ -1,219 +1,27 @@
-require "a_parser_client/version"
+# frozen_string_literal: true
+
+require 'a_parser_client/version'
+require 'a_parser_client/api'
 
 module AParserClient
   class Error < StandardError; end
 
-  class API
-  	require "json"
-  	require "open-uri"
-  	require "net/http"
-
-  	attr :api_url, :api_password, :alive
-
-  	def initialize(api_url, api_password)
-  		if api_url =~ URI::regexp
-	  		@api_url = api_url
-	  		@api_password = api_password	
-	  		@alive = self.alive?			
-  		else
-  			raise "Bad API URL provided."
-  		end
-  	end
-
-	def ping
-		request = {
-			password: @api_pass, 
-			action: 'ping'
-		}
-		do_it request
-	end
-
-	#updates alive status
-	def alive?
-		@alive = ping ? true : false
-	end  
-
-
-	def get_task_list(completed=false)
-		request = {
-			password: @api_password, 
-			action: 'getTasksList',
-			data: {completed: completed ? 1 : 0}
-		}
-		do_it request
-	end
-
-	def get_task_state(task_id)
-		request = {
-			password: @api_password, 
-			action: 'getTaskState',
-			data: {taskUid: task_id}
-		}
-		do_it request
-	end
-
-	def get_task_conf(task_id)
-		request = {
-			password: @api_password, 
-			action: 'getTaskConf',
-			data: {taskUid: task_id}
-		}
-		do_it request
-	end
-
-
-	def get_info
-		request = {
-			password: 	@api_password, 
-			action: 	'info',
-		}
-		do_it request
-	end
-
-	def add_task(task_type='text', queries_array=[], queries_file=nil, config, preset, parsers, result_file_name)
-		request = {
-			password: 	@api_password, 
-			action: 	'addTask',
-			data: {
-				queriesFrom: task_type, 
-				queries: (task_type == 'text' ? queries_array : queries_file),
-				configPreset: config, 
-				preset: preset, 
-				parsers: parsers, 
-				resultsFileName: result_file_name
-			}
-		}
-		do_it request
-	end
-
-	def change_task_status(task_id, to_status)
-		request = {
-			password: @api_password, 
-			action: 'changeTaskStatus',
-			data: {
-				taskUid: task_id,
-				toStatus: to_status
-			}
-		}
-		do_it request		
-	end
-
-	def get_accounts_count
-		request = {
-			password: @api_password, 
-			action: 'getAccountsCount',
-			data: {}
-		}
-		do_it request		
-	end
-
-
-	def get_proxies
-		request = {
-			password: @api_password, 
-			action: 'getProxies'
-		}
-		do_it request		
-	end
-
-	def update!
-		request = {
-			password: @api_password, 
-			action: 'update',
-			data: {}
-		}
-		do_it request		
-	end	
-
-	def get_task_results_file(task_id)
-		request = {
-			password: @api_password, 
-			action: 'getTaskResultsFile',
-			data: {taskUid: task_id}
-		}
-		do_it request
-	end	
-
-	def delete_task_results_file(task_id)
-		request = {
-			password: @api_password, 
-			action: 'deleteTaskResultsFile',
-			data: {taskUid: task_id}
-		}
-		do_it request
-	end	
-
-	def move_task(task_id, direction)
-		request = {
-			password: @api_password, 
-			action: 'moveTask',
-			data: {
-				taskUid: task_id,
-				toStatus: direction
-			}
-		}
-		do_it request		
-	end	
-
-	def get_parser_info(parser_name)
-		request = {
-			password: @api_password, 
-			action: 'getParserInfo',
-			data: {
-				parser: parser_name
-			}
-		}
-		do_it request		
-	end	
-
-
-	def get_parser_preset(parser_name, preset_name)
-		request = {
-			password: @api_password, 
-			action: 'getParserInfo',
-			data: {
-				parser: parser_name,
-				reset: preset_name
-			}
-		}
-		do_it request		
-	end	
-
-
-		private # internal use only
+  class Control
+    attr_reader :tasks, :driver
 
-	def do_it(request)
-		request_body = request.to_json
-		response = send_request(request_body)
-		return response		
-	end
+    def initialize(api_driver)
+      @driver = api_driver
 
-	def send_request(request)
-		uri = URI @api_url
+      raise 'No API driver provided.' unless @driver
 
-			req = Net::HTTP::Post.new uri
-			req.body = (request)
-			req.content_type = 'text/plain; charset=UTF-8'
+      raise 'API driver should be alive to take control of parser.' unless @driver.alive?
 
-			begin
-				res = Net::HTTP.start(uri.hostname, uri.port) {|http|
-				  http.request(req)
-				}
-			rescue Exception => e
-				puts "Send request error: #{e}"
-			end
+      @tasks = fetch_tasks
+    end
 
-			if res
-				begin
-					response = JSON.parse res.body
-				rescue JSON::ParserError => e
-					raise "Not a JSON type response from the server #{@api_url}. Probably not an API endpoint."
-				end
-			else
-			  nil
-			end
-	end			
-  	
-  	
+    def fetch_tasks
+      data = @driver.get_tasks_list
+      data['data'] || []
+    end
   end
 end

data/lib/a_parser_client/api.rb

@@ -0,0 +1,238 @@
+# frozen_string_literal: true
+
+module AParserClient
+  class API
+    require 'json'
+    require 'open-uri'
+    require 'net/http'
+
+    attr :api_url, :api_password, :alive
+
+    def initialize(api_url, api_password)
+      raise 'Bad API URL provided.' unless api_url =~ URI::DEFAULT_PARSER.make_regexp
+
+      @api_url = api_url
+      @api_password = api_password
+      @alive = alive?
+    end
+
+    def ping
+      request = {
+        password: @api_password,
+        action: 'ping'
+      }
+      do_it request
+    end
+
+    # updates alive status
+    def alive?
+      @alive = ping ? true : false
+    end
+
+    def get_tasks_list(completed = false)
+      request = {
+        password: @api_password,
+        action: 'getTasksList',
+        data: { completed: completed ? 1 : 0 }
+      }
+      do_it request
+    end
+
+    def get_task_state(task_id)
+      request = {
+        password: @api_password,
+        action: 'getTaskState',
+        data: { taskUid: task_id }
+      }
+      do_it request
+    end
+
+    def get_task_conf(task_id)
+      request = {
+        password: @api_password,
+        action: 'getTaskConf',
+        data: { taskUid: task_id }
+      }
+      do_it request
+    end
+
+    def get_info
+      request = {
+        password: @api_password,
+        action: 'info',
+      }
+      do_it request
+    end
+
+    def add_task(task_type = 'text', queries_array = [], queries_file = nil, config, preset, parsers, result_file_name)
+      request = {
+        password: @api_password,
+        action: 'addTask',
+        data: {
+          queriesFrom: task_type,
+          queries: (task_type == 'text' ? queries_array : queries_file),
+          configPreset: config,
+          preset: preset,
+          parsers: parsers,
+          resultsFileName: result_file_name
+        }
+      }
+      do_it request
+    end
+
+    def one_request(query, parser, preset = 'default', config_preset = 'default', options = [])
+      request = {
+        password: @api_password,
+        action: 'oneRequest',
+        data: {
+          query: query,
+          parser: parser,
+          configPreset: config_preset,
+          preset: preset,
+          options: options
+        }
+      }
+      do_it request
+    end
+
+    def bulk_request(queries, parser, preset, config_preset, threads, raw_results, need_data, options)
+      request = {
+        password: @api_password,
+        action: 'bulkRequest',
+        data: {
+          queries: queries,
+          parser: parser,
+          configPreset: config_preset,
+          preset: preset,
+          threads: threads,
+          rawResults: raw_results,
+          needData: need_data,
+          options: options
+        }
+      }
+      do_it request
+    end
+
+    def change_task_status(task_id, to_status)
+      request = {
+        password: @api_password,
+        action: 'changeTaskStatus',
+        data: {
+          taskUid: task_id,
+          toStatus: to_status
+        }
+      }
+      do_it request
+    end
+
+    def get_accounts_count
+      request = {
+        password: @api_password,
+        action: 'getAccountsCount',
+        data: {}
+      }
+      do_it request
+    end
+
+    def get_proxies
+      request = {
+        password: @api_password,
+        action: 'getProxies'
+      }
+      do_it request
+    end
+
+    def update!
+      request = {
+        password: @api_password,
+        action: 'update',
+        data: {}
+      }
+      do_it request
+    end
+
+    def get_task_results_file(task_id)
+      request = {
+        password: @api_password,
+        action: 'getTaskResultsFile',
+        data: { taskUid: task_id }
+      }
+      do_it request
+    end
+
+    def delete_task_results_file(task_id)
+      request = {
+        password: @api_password,
+        action: 'deleteTaskResultsFile',
+        data: { taskUid: task_id }
+      }
+      do_it request
+    end
+
+    def move_task(task_id, direction)
+      request = {
+        password: @api_password,
+        action: 'moveTask',
+        data: {
+          taskUid: task_id,
+          toStatus: direction
+        }
+      }
+      do_it request
+    end
+
+    def get_parser_info(parser_name)
+      request = {
+        password: @api_password,
+        action: 'getParserInfo',
+        data: {
+          parser: parser_name
+        }
+      }
+      do_it request
+    end
+
+    def get_parser_preset(parser_name, preset_name)
+      request = {
+        password: @api_password,
+        action: 'getParserInfo',
+        data: {
+          parser: parser_name,
+          reset: preset_name
+        }
+      }
+      do_it request
+    end
+
+    private # internal use only
+
+    def do_it(request)
+      request_body = request.to_json
+      send_request(request_body)
+    end
+
+    def send_request(request)
+      uri = URI @api_url
+
+      req = Net::HTTP::Post.new uri
+      req.body = (request)
+      req.content_type = 'text/plain; charset=UTF-8'
+
+      begin
+        res = Net::HTTP.start(uri.hostname, uri.port) do |http|
+          http.request(req)
+        end
+      rescue StandardError => e
+        puts "Send request error: #{e}"
+      end
+
+      return unless res
+
+      begin
+        JSON.parse res.body
+      rescue JSON::ParserError => e
+        raise "Not a JSON type response from the server #{@api_url}. Probably not an API endpoint. Error: #{e}"
+      end
+    end
+  end
+end

data/lib/a_parser_client/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module AParserClient
-  VERSION = "0.1.6"
+  VERSION = '0.1.12'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: a_parser_client
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.12
 platform: ruby
 authors:
 - Yaroslav Shevchenko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-25 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +72,7 @@ files:
 - bin/console
 - bin/setup
 - lib/a_parser_client.rb
+- lib/a_parser_client/api.rb
 - lib/a_parser_client/version.rb
 homepage: https://github.com/yvshevchenko/a_parser_client
 licenses:
@@ -96,8 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A simple inerface to A-Parser API.