outscraper 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65a939a94dd3d9793fa52fb70d88e459ecdf5e89094488c87556872d1c300089
-  data.tar.gz: 8351ff51f9ed94399499b70618c3b3c1c93e0d1a60ec9a4bef48a673a8024341
+  metadata.gz: 9d30d94dec1449e809f12bfb520db6a48f1e8cee6cbb5d7aefb81b145c7d8ef3
+  data.tar.gz: b5c7c30ec0656d227090169d7ba154e94452a44d67023099627c2f61a21f59f8
 SHA512:
-  metadata.gz: ce6b3e0340fe063b0873d86a1fd969dd862f3411a62b9763b4475fe0b7291b4cce7082a33c07a46d9c63cc7a3b0a33be85b288ee714fb6f548d3585f76ed71da
-  data.tar.gz: 6203eddded899cd60453e56159c21117540bf052e6abc7cdeb4c5ac3a7b5a9c0e29abcb09fd533b344b2269a542c7f61831b0e86da91c5aaf994b9a0adea288a
+  metadata.gz: 1615e0a98977b113fc62293cc18282bab0238d974767ec3a920d6eeb5bae3ebd54aa905209cb2e1c864c7f601aa1efd77103836d9a60707bcdda31071e32eef9
+  data.tar.gz: 3e8a7103940b8e548af332087e4a65abcd3cafe004a329ed27cd2d80db3eba158a94a37e399de2bc517e449007926d76b843f545a82377b6a0bf35751ddc0306

data/README.md

@@ -1,22 +1,46 @@
-# Outscraper
+# Outscraper Ruby Library
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/outscraper`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+The library provides convenient access to the [Outscraper API](https://app.outscraper.com/api-docs) from applications written in the Ruby language. Allows using [Outscraper's services](https://outscraper.com/services/) from your code.
 
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add outscraper
+```bash
+bundle add outscraper
+```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
+```bash
+gem install outscraper
+```
+
+[Link to the Ruby package page](https://rubygems.org/gems/outscraper)
 
-    $ gem install outscraper
+## Initialization
+```ruby
+require 'Outscraper'
+
+client = Outscraper::Client.new('SECRET_API_KEY')
+```
+[Link to the profile page to create the API key](https://app.outscraper.com/profile)
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+# Search for businesses in specific locations:
+result = client.google_maps_search_v2('restaurants brooklyn usa', limit: 20, language: 'en', region: 'us')
+
+# Get data of the specific place by id
+result = client.google_maps_search_v2('ChIJrc9T9fpYwokRdvjYRHT8nI4', language: 'en')
+
+# Get reviews of the specific place by id
+result = client.google_maps_reviews_v3('ChIJrc9T9fpYwokRdvjYRHT8nI4', reviews_limit: 20, language: 'en')
+
+# Search contacts from website
+result = client.emails_and_contacts('outscraper.com')
+```
+
+[More examples](https://github.com/outscraper/outscraper-ruby/tree/master/examples)
 
 ## Development
 
@@ -27,11 +51,3 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/outscraper/outscraper-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/outscraper/outscraper-ruby/blob/master/CODE_OF_CONDUCT.md).
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Outscraper project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/outscraper/outscraper-ruby/blob/master/CODE_OF_CONDUCT.md).

data/examples/Emails And Contacts.md

@@ -0,0 +1,32 @@
+# Emails And Contacts Scraper With Ruby
+
+Allows finding email addresses, social links, and phones from domains via [Outscraper API](https://app.outscraper.com/api-docs#tag/Emails-and-Contacts).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+```bash
+bundle add outscraper
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+```bash
+gem install outscraper
+```
+
+[Link to the Ruby package page](https://rubygems.org/gems/outscraper)
+
+## Initialization
+```ruby
+require 'Outscraper'
+
+client = Outscraper::Client.new('SECRET_API_KEY')
+```
+[Link to the profile page to create the API key](https://app.outscraper.com/profile)
+
+## Usage
+
+```ruby
+# Search contacts from website:
+result = client.emails_and_contacts('outscraper.com')
+```

data/examples/Google Maps Reviews.md

@@ -0,0 +1,41 @@
+# Google Maps Reviews Scraper With Ruby
+
+The library provides real-time access to the reviews from Google Maps via [Outscraper API](https://app.outscraper.com/api-docs#tag/Google-Reviews).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+```bash
+bundle add outscraper
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+```bash
+gem install outscraper
+```
+
+[Link to the Ruby package page](https://rubygems.org/gems/outscraper)
+
+## Initialization
+```ruby
+require 'Outscraper'
+
+client = Outscraper::Client.new('SECRET_API_KEY')
+```
+[Link to the profile page to create the API key](https://app.outscraper.com/profile)
+
+## Usage
+
+```ruby
+# Get reviews of the specific place by id
+result = client.google_maps_reviews_v3('ChIJrc9T9fpYwokRdvjYRHT8nI4', reviews_limit: 20, language: 'en')
+
+# Get reviews for places found by search query
+result = client.google_maps_reviews_v3('Memphis Seoul brooklyn usa', reviews_limit: 20, limit: 500, language: 'en')
+
+# Get only new reviews during last 24 hours
+yesterday_timestamp = 1657980986
+
+result = client.google_maps_reviews_v3(
+    'ChIJrc9T9fpYwokRdvjYRHT8nI4', sort: 'newest', cutoff: yesterday_timestamp, reviews_limit: 100, language: 'en')
+```

data/examples/Google Maps.md

@@ -0,0 +1,35 @@
+# Google Maps Scraper With Ruby
+
+The library provides real-time access to the places from Google Maps via [Outscraper API](https://app.outscraper.com/api-docs#tag/Google-Maps).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+```bash
+bundle add outscraper
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+```bash
+gem install outscraper
+```
+
+[Link to the Ruby package page](https://rubygems.org/gems/outscraper)
+
+## Initialization
+```ruby
+require 'Outscraper'
+
+client = Outscraper::Client.new('SECRET_API_KEY')
+```
+[Link to the profile page to create the API key](https://app.outscraper.com/profile)
+
+## Usage
+
+```ruby
+# Search for businesses in specific locations:
+result = client.google_maps_search_v2('restaurants brooklyn usa', limit: 20, language: 'en', region: 'us')
+
+# Get data of the specific place by id
+result = client.google_maps_search_v2('ChIJrc9T9fpYwokRdvjYRHT8nI4', language: 'en')
+```

data/examples/Phones Validator.md

@@ -0,0 +1,32 @@
+# Phone Numbers Enricher/Validator
+
+Returns phones carrier data (name/type), validates phones, ensures messages deliverability via [Outscraper API](https://app.outscraper.com/api-docs#tag/Phones/paths/~1phones-enricher/get).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+```bash
+bundle add outscraper
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+```bash
+gem install outscraper
+```
+
+[Link to the Ruby package page](https://rubygems.org/gems/outscraper)
+
+## Initialization
+```ruby
+require 'Outscraper'
+
+client = Outscraper::Client.new('SECRET_API_KEY')
+```
+[Link to the profile page to create the API key](https://app.outscraper.com/profile)
+
+## Usage
+
+```ruby
+# Search contacts from website:
+result = client.phones_enricher('12812368208')
+```

data/lib/outscraper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Outscraper
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/outscraper.rb

@@ -49,5 +49,12 @@ module Outscraper
         async: false,
       }).parsed_response['data']
     end
+
+    def phones_enricher(query)
+      response = self.class.get("/phones-enricher", 'query': {
+        query: query,
+        async: false,
+      }).parsed_response['data']
+    end
   end
 end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: outscraper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Outscraper
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
 date: 2022-07-16 00:00:00.000000000 Z
@@ -39,6 +39,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/Emails And Contacts.md
+- examples/Google Maps Reviews.md
+- examples/Google Maps.md
+- examples/Phones Validator.md
 - lib/outscraper.rb
 - lib/outscraper/version.rb
 - sig/outscraper.rbs
@@ -52,7 +56,7 @@ metadata:
   bug_tracker_uri: https://github.com/outscraper/outscraper-ruby/issues
   documentation_uri: https://app.outscraper.com/api-docs
   github_repo: ssh://github.com/outscraper/outscraper-ruby
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -67,8 +71,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.11
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Outscraper API
 test_files: []