bogeyman 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2eb68c19d409fa417daab614f90096339619ed9b
-  data.tar.gz: 8aed3ec07f6f3d7d6f48dd99871c97fb9ec34ffb
+  metadata.gz: 625872cca43376ec239d79f030d6c15413ca6202
+  data.tar.gz: b3442d45b21396e1cf0c14961a312569cbaff28b
 SHA512:
-  metadata.gz: b6f7db6ecb1ad5d951d057076b3cf9859ce9388e4fbdd371bb86404bcf05d637767cc0fd56d2ef6c7a737f56b08d2caaac3f3949d77e9dc2e072b7275b49c96d
-  data.tar.gz: 2bbfe74ea5558a53b9e63e2e039f37f61ef2901b523baf1b2909496f7a827d297c490f0186dea27b8710b40b4a1802be27f90375d8be30ef8d5d873a379fe3dc
+  metadata.gz: 0c211c9503823b24d6dc10c153f191d2f5a7692749c696d680ab5ba2e081c00f6893f5b7b854f0625b3305fe472784c883ad6abc9a39700c5b3e6b1fbdaa12af
+  data.tar.gz: 80df69a7256b3434d08dd92017ea71d8af0642a65a11f3f9342a41c740c14fc2ab9266c53404bb623f06ef73e486c2a17498c969ba79c16a175e390d7eb4591d

data/README.md

@@ -0,0 +1,67 @@
+# Bogeyman Ruby Client
+
+Bogeyman is Ruby client for
+[Bogeyman.js](https://github.com/reneklacan/bogeyman.js)
+which is server application providing headless **crawling
+of heavy javascript web sites** via REST API.
+
+## Installation
+
+You can install it via gem
+
+```bash
+gem install bogeyman
+```
+
+Or you can put it in your Gemfile
+
+```ruby
+gem 'bogeyman', '~> 0.0.2'
+```
+
+## Usage
+
+At first make sure that your server is installed and running
+
+```bash
+npm install -g bogeyman # install it
+bogeyman # start it
+```
+
+For more information about server follow [this
+link](https://github.com/reneklacan/bogeyman.js)
+
+So when your server is set up then you can do
+
+```ruby
+require 'bogeyman'
+
+client = Bogeyman::Client.new
+client.post 'http://example.com', param1: 'abc'
+client.get 'http://example.com'
+```
+
+Or if you require advanced options
+
+```ruby
+client = Bogeyman::Client.new(
+  host: 'bogeyman.com',         # default: 'localhost'
+  port: 12345,                  # default: 12345
+  proxy: '127.0.0.1:41414',     # default: nil
+  proxy_type: 'socks5',         # default: 'http'
+  proxy_auth: 'user:passwd',    # default: nil
+  disk_cache: true,             # default: false
+  max_disk_cache_size: '1024',  # default: nil
+  ssl_protocol: 'any',          # default: 'sslv3'
+  ssl_certificates-path: '...', # default: system default
+  web_security: true,           # default: false
+)
+```
+
+For more information you can take a look at
+[Bogeyman.js](https://github.com/reneklacan/bogeyman.js) or [PhantomJS
+API Reference](https://github.com/ariya/phantomjs/wiki/API-Reference).
+
+## License
+
+This library is distributed under the Beerware license.

data/lib/bogeyman/client.rb

@@ -3,13 +3,27 @@
 module Bogeyman
   class Client
     def initialize params={}
+      host = params.delete(:host) || 'localhost'
+      port = params.delete(:port) || 31313
+
+      @server = "http://#{host}:#{port}"
       @params = params
-      @server = 'http://localhost:31313'
     end
 
-    def get url, params={}
-      params = @params.dup.update(params)
-      params.update(method: 'GET', url: url)
+    [:get, :post, :patch, :delete].each do |method|
+      define_method method do |url, data={}|
+        request(method, url, data)
+      end
+    end
+
+    protected
+
+    def request method, url, data
+      params = {
+        method: method,
+        url: url,
+        params: @params,
+      }
 
       Response.new(
         JSON.parse(

data/lib/bogeyman/version.rb

@@ -1,3 +1,3 @@
 module Bogeyman
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bogeyman
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Rene Klacan
@@ -62,6 +62,7 @@ files:
 - lib/bogeyman/client.rb
 - lib/bogeyman/version.rb
 - lib/bogeyman.rb
+- README.md
 homepage: https://github.com/reneklacan/bogeyman
 licenses:
 - Beerware