Project

sourcescrub

0.0
Low commit activity in last 3 years
sourcescrubekohe/sourcescrubHomepageDocumentationSource CodeBug TrackerWiki
Sourcescrub is a ruby wrapper based on Source Scrub API.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
18,137
Stars
1
Forks
0
Watchers
5
 Releases
Current version
0.1.3
Total releases
12
First release
2020-06-20
Latest release
2024-06-17
 Issues
Open Issues
0
Closed Issues
4
Total Issues
4
Issue Closure Rate
100%
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
0
Merged Pull Requests
2
Pull Request Acceptance Rate
100%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2020-12-13
Reverse Dependencies
0

 Dependencies

Development

pry
>= 0
rubocop
>= 0
vcr
>= 0
webmock
>= 0

Runtime

faraday
>= 0
 Project Readme

Sourcescrub

Sourcescrub is a ruby wrapper based on Source Scrub API, Here is API documentation: https://api.sourcescrub.com/index.html.

However, we need to request an access account from Sourcescrub.

Gem Version Build Status

Installation

Add this line to your application's Gemfile:

gem 'sourcescrub'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install sourcescrub

Getting Started

Configure your certificate for API

require 'sourcescrub'

account = YAML.load(File.read('sourcescrub.yml'))
Sourcescrub.account do |config|
  config.username = account['username']
  config.password = account['password']
  config.basic    = account['basic']
  config.debug    = false # Default is false, If you want to know the request information, can set the debug = true
end

Usage

Class: Client for API

pry(main)> client = Sourcescrub::Client.new

Request your token

pry(main)> client.headers
=> {"Authorization"=>"Bearer eyJhbGciOiJSUzI1NiIsImtpZCI........"}

API request for endpoint we completed

<!-- Company -->
response = client.company('ekohe.com') # get data by domain
response = client.company('LZ281NVD') # get data by SS ID

<!-- Get the JSON response of Company -->

response.as_json

Companies

Get the company data by domain or Sourcescrub ID

pry(main)> response = client.company('ekohe.com')
=> #<Sourcescrub::Models::Company:0x00007f9e915161c0
 @city="Xinzhuang",
 @companyType="Private",
 @country="China",
 @crunchbase=nil,
 @currentEmployeeCount=41,
 @currentEmployeeRange="11-50",
 @currentJobOpenings=0,
 @description=
  "Ekohe, Ltd. is a cutting-edge web and mobile design and development agency. It specialize in digital strategy, innovative technology and user-centered design experiences from conceptualization to market launch.",
 @domain="ekohe.com",
 @facebook=nil,
=> #<Sourcescrub::Models::Company:0x00007f9e915161c0
 @city="Xinzhuang",
 @companyType="Private",
 @country="China",
 @crunchbase=nil,
 @currentEmployeeCount=41,
 @currentEmployeeRange="11-50",
 @currentJobOpenings=0,
 @description=
  "Ekohe, Ltd. is a cutting-edge web and mobile design and development agency. It specialize in digital strategy, innovative technology and user-centered design experiences from conceptualization to market la
unch.",
 @domain="ekohe.com",
 @facebook=nil,
 @firmTags=[],
 @foundingYear=2007,
 @id="LZ281NVD",
 @informalName="Ekohe",
 @investors="",
 @linkedIn="https://www.linkedin.com/company/ekohe",
 @location="Xinzhuang, Shanghai Shi, China",
 @name="Ekohe, Ltd.",
 @parentCompanyDomain=nil,
 @personalTags=[],
 @phoneNumber="",
 @postalCode=nil,
 @specialties=
  ["IT & Startup Consulting",
   "Ruby on Rails leaders",
   "Intelligent Web & Mobile Development",
   "Usable Web & Mobile design",
   "UX or UI Design",
   "Artificial Intelligence",
   "Machine Learning",
   "Data Sourcing",
   "FinTech Tools"],
 @state="Shanghai Shi",
 @totalAmountInvested=0,
 @twitter=nil,
 @website="https://ekohe.com">
pry(main)> response.name
=> "Ekohe, Ltd."
pry(main)> response.domain
=> "ekohe.com"
pry(main)> response.as_json
=> {:id=>"LZ281NVD",
 :companyType=>"Private",
 :name=>"Ekohe, Ltd.",
 :informalName=>"Ekohe",
 :website=>"https://ekohe.com",
 :domain=>"ekohe.com",
 :description=>
  "Ekohe, Ltd. is a cutting-edge web and mobile design and development agency. It specialize in digital strategy, innovative technology and user-centered design experiences from conceptualization to market launch.",
 :foundingYear=>2007,
 :location=>"Xinzhuang, Shanghai Shi, China",
 :city=>"Xinzhuang",
 :state=>"Shanghai Shi",
 :postalCode=>nil,
 :country=>"China",
 :parentCompanyDomain=>nil,
 :phoneNumber=>"",
 :specialties=>
  ["IT & Startup Consulting",
   "Ruby on Rails leaders",
   "Intelligent Web & Mobile Development",
   "Usable Web & Mobile design",
   "UX or UI Design",
   "Artificial Intelligence",
   "Machine Learning",
   "Data Sourcing",
   "FinTech Tools"],
 :facebook=>nil,
 :twitter=>nil,
 :crunchbase=>nil,
 :linkedIn=>"https://www.linkedin.com/company/ekohe",
 :totalAmountInvested=>0,
 :currentEmployeeCount=>41,
 :currentEmployeeRange=>"11-50",
 :currentJobOpenings=>0,
 :investors=>"",
 :personalTags=>[],
 :firmTags=>[]}

Searches

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ekohe/sourcescrub. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Sourcescrub project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.