a_parser_client 0.1.3 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adc4f9ce094b307b0dd2498562c9b3fed6046550336547e894c75fc480dbfe52
-  data.tar.gz: fea8994be0bfb6ecb417fbabf5c4c956aa71d21b3e2543ea0a1777d9ff0e0525
+  metadata.gz: 8a8bc499efb525fbec81f9baf371d53996c8b161ff84be8bf99d5716a1fd4bdc
+  data.tar.gz: 828b64103b24b88d37215e47b4ff218fe0792d61332bdd4a73d239b65e7255aa
 SHA512:
-  metadata.gz: 0b752657ce7da0730c2b374ded49bd58031b23a55bc0b18b5f71db130c8ca5bb54dd842226d8b68e00cf32dac418d5baec6dc2cd3d0d7207a52f7aa68e5cec10
-  data.tar.gz: e2ce75960aae66819ba31e785b9a368178dd9aae2e08a1897a1c112158f3e16fc63ddd42cd642cb50b483a0a1e75b81e6c4225cdc7635d2ec080a40de8301cf2
+  metadata.gz: 7ebb4925c0aaf3dc294966d36e26bc189b1b6474a9c7071f6bd7f4737c032ae74fec440fc9879d6fc4ddef97889e38e36607ea00d90abe941a346bd9155e6540
+  data.tar.gz: 9406200c8dc40bd5bf51e3334243c6d32c67be0d4c39eb5e3bdba3cc63f9a5bfe9373dea43ff66cd9c13b479321ded812dcdc8325c3fa40baa149963474f7c01

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    a_parser_client (0.1.3)
+    a_parser_client (0.1.8)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,31 +1,37 @@
 # AParserClient
 
+[![Gem Version](https://badge.fury.io/rb/a_parser_client.svg)](https://badge.fury.io/rb/a_parser_client)
+
 Ruby client for A-Parser user API.
 
 This is a test release, more API coverage is upcoming.
 
 Covered for now:
 
-	-	ping
-	-	info
-	- 	getTaskList
-	-	getTaskState
-	-	getTaskConf
-	-	addTask
-	-	changeTaskStatus
+-	ping
+-	info
+- 	getTaskList
+-	getTaskState
+-	getTaskConf
+-	addTask
+-	changeTaskStatus
+-	getAccountsCount	
+-	getProxies	
+-	update	
+-	getTaskResultsFile	
+-	deleteTaskResultsFile	
+-	moveTask	
+-	getParserInfo	
+-	getParserPreset	
+-	oneRequest
+-	bulkRequest
 
 TODO:
 
-	-	oneRequest
-	-	bulkRequest
-	-	getParserPreset
-	-	getProxies
-	-	getTaskResultsFile
-	-	deleteTaskResultsFile
-	-	moveTask
-	-	getParserInfo
-	-	update
-	-	getAccountsCount	
+Some automation procedures:
+
+-	multitasks operations (like stop all tasks etc.)
+
 
 ## Installation
 
@@ -45,13 +51,17 @@ Or install it yourself as:
 
 ## Usage
 
+There will be a wiki page soon.
+
+The code sample below is all for now...
+
 ```ruby
 require 'a_parser_client'
 
-api = AParserClient::API.new 'http://142.54.182.130:9091/API, ''
-api.ping
+ api = AParserClient::API.new 'http://<your_host_running_aparser>:9091/API, ''
+ api.ping
 
-$> {"success" : 1, "data" : "pong"}
+=> {"success" : 1, "data" : "pong"}
 ```
 
 ## Development
@@ -70,4 +80,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the AParserClient project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yvshevchenko	/a_parser_client/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the AParserClient project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yvshevchenko/a_parser_client/blob/master/CODE_OF_CONDUCT.md).

data/a_parser_client.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Yaroslav Shevchenko"]
   spec.email         = ["yvshevchenko@gmail.com"]
 
-  spec.summary       = %q{A simple inerface to a-parser API.}
-  spec.description   = %q{Gem allowing to use a-parser API simple way.}
+  spec.summary       = %q{A simple inerface to A-Parser API.}
+  spec.description   = %q{Gem allowing to use A-Parser API simple way.}
   spec.homepage      = "https://github.com/yvshevchenko/a_parser_client"
   spec.license       = "MIT"
 
@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/yvshevchenko/a_parser_client"
-  spec.metadata["changelog_uri"] = "https://github.com/yvshevchenko/a_parser_client"
+  spec.metadata["changelog_uri"] = "https://github.com/yvshevchenko/a_parser_client/wiki/Changes-Log"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/a_parser_client.rb

@@ -1,138 +1,28 @@
 require "a_parser_client/version"
+require "a_parser_client/api"
 
 module AParserClient
-  class Error < StandardError; end
+	class Error < StandardError; end
 
-  class API
-  	require "json"
-  	require "open-uri"
-  	require "net/http"
+	class Control
+		attr_reader :tasks
 
-  	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_a_parser
-		request = {
-			password: @api_pass, 
-			action: 'ping'
-		}
-		do_it request
-	end
-
-	#updates alive status
-	def alive?
-		@alive = ping_a_parser ? 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 initialize(api_driver)
+			if api_driver
+				unless api_driver.alive?
+					raise "API driver should be alive to take control of parser."
+				end
 
+				@tasks = fetch_tasks				
+			else
+				raise "No API driver provided."
+			end
 
-		private # internal use only
+		end
 
-	def do_it(request)
-		request_body = request.to_json
-		response = send_request(request_body)
-		return response		
+		def fetch_tasks
+			data = api_driver.get_tasks_list
+			data['data'] ? data['data'] : []
+		end
 	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) {|http|
-				  http.request(req)
-				}
-			rescue Exception => e
-				puts "Send request error: #{e}"
-			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			
-  	
-  	
-  end
 end

data/lib/a_parser_client/api.rb

@@ -0,0 +1,253 @@
+module AParserClient
+
+  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_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
+		response = send_request(request_body)
+		return response		
+	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) {|http|
+				  http.request(req)
+				}
+			rescue Exception => e
+				puts "Send request error: #{e}"
+			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			
+  	
+  	
+  end
+
+
+end

data/lib/a_parser_client/version.rb

@@ -1,3 +1,3 @@
 module AParserClient
-  VERSION = "0.1.3"
+  VERSION = "0.1.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: a_parser_client
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.8
 platform: ruby
 authors:
 - Yaroslav Shevchenko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-24 00:00:00.000000000 Z
+date: 2020-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Gem allowing to use a-parser API simple way.
+description: Gem allowing to use A-Parser API simple way.
 email:
 - yvshevchenko@gmail.com
 executables: []
@@ -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:
@@ -80,7 +81,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/yvshevchenko/a_parser_client
   source_code_uri: https://github.com/yvshevchenko/a_parser_client
-  changelog_uri: https://github.com/yvshevchenko/a_parser_client
+  changelog_uri: https://github.com/yvshevchenko/a_parser_client/wiki/Changes-Log
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -100,5 +101,5 @@ rubyforge_project:
 rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
-summary: A simple inerface to a-parser API.
+summary: A simple inerface to A-Parser API.
 test_files: []