githubgrab 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ce0492b4b381ac96a8f5942d26a3ca3bf31b146
+  data.tar.gz: e72942dbf3b05edc798a156c27fe6b84b0c152cc
+SHA512:
+  metadata.gz: 00a6a2cf22ee7e2f0f8aac269abbb7eda5ee9a4244b6a0efeb3e353f86ce3d6805434c05bcba427750cd08923912bfda171863d435819ed6a7c30689375350e7
+  data.tar.gz: a2c112beb4c8642938fd668dc4530fe26383c0111608d31ea522e1afa70f2b61d7921b7110426ebe6fee4f027e74e7ef13efd42927eddc04f90a1961ed671f81

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+tasks
+.DS_Store
+/topic*
+

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.7
+before_install: gem install bundler -v 1.16.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ali@regentmarkets.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in githubgrab.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    githubgrab (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    colorize (0.8.1)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (0.3.7)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
+    minitest (5.11.3)
+    netrc (0.11.0)
+    public_suffix (3.0.3)
+    rake (10.4.2)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    safe_yaml (1.0.4)
+    thread (0.2.2)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+    webmock (3.4.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  colorize
+  githubgrab!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  rest-client
+  thread
+  webmock
+
+BUNDLED WITH
+   1.16.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 sizief
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+[![Gem Version](https://badge.fury.io/rb/githubgrab.svg)](https://badge.fury.io/rb/githubgrab)
+
+
+# Githubgrab
+
+This is a very simple CLI to get profile pictures of Github users. It uses the Github public API and for now it saves the first batch of response, first 30 images.  
+
+  
+## Installation
+ 
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'githubgrab'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install githubgrab
+
+## Usage
+ To get profile pictures of users who tagged `ruby`  
+`bin/githubgrab topic:ruby`  
+and check the `topic:ruby` folder in the root.
+
+
+Or finding topic `rails` and `ruby`
+
+`bin/githubgrab topic:ruby topic:rails`
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sizief/gig. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 Githubgrab project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sizief//blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/githubgrab

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require_relative "../lib/githubgrab"
+
+Githubgrab::CLI.new ARGV

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/githubgrab.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "githubgrab/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "githubgrab"
+  spec.version       = Githubgrab::VERSION
+  spec.authors       = ["sizief"]
+  spec.email         = ["sizief@gmail.com"]
+
+  spec.summary       = "Very simple CLI to download Github profile images"
+  spec.homepage      = "http://github.com/sizief/gig"
+  spec.license       = "MIT"
+
+
+  # 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.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "rest-client"
+  spec.add_development_dependency "colorize"
+  spec.add_development_dependency "thread"
+end

data/lib/githubgrab/cli.rb

@@ -0,0 +1,21 @@
+require_relative 'gateway'
+require 'colorize'
+
+module Githubgrab
+
+  class CLI
+    def initialize args 
+      api_results = Gateway.call(args)
+      if api_results[:code] == 200
+        puts "Connecting to Github complete! Downloading images now".colorize(:green)
+        downloader = Downloader.new Githubgrab::Helper::extract_image_urls(api_results[:body]), args.join("-")
+        downloader.save_all
+      else
+        puts api_results[:body].colorize(:red)
+      end
+    end
+  end
+
+end
+# TODO: give more options to users by using 'optparse'
+# TODO: separate the logic from CLI so we can use Githubgrab with more interfaces

data/lib/githubgrab/downloader.rb

@@ -0,0 +1,60 @@
+require 'rest-client'
+require 'thread/pool'
+
+module Githubgrab
+  
+  class Downloader 
+
+    TIME_VALIDITY = 60*60.to_f #images are valid if downloaded within recent one hour
+    THREAD_LIMIT = 10.to_i #change this based on your hard drive IO capability and internet bandwidth
+    
+    def initialize urls, destination
+      @urls = urls
+      @destination = destination
+    end
+
+    #download and save files in THREAD_LIMIT item batches, because we don't have any queue system to save failed requests,
+    #it if better to be cautious and think of IO and bandwidth limits.
+    #TODO: add something like Sidekiq to retry failed requests.
+    def save_all
+      pool = Thread.pool(THREAD_LIMIT)
+      create_folder
+      @urls.each do |url|
+        pool.process {save url} 
+      end
+      pool.shutdown
+    end
+
+    private
+    def create_folder
+      unless @urls.empty? # we don't need to create folders for empty requests
+        Dir.mkdir @destination unless File.directory? @destination
+      end
+    end
+
+    def save url
+      unless image_exists url
+        begin
+          res = RestClient.get url
+          file_name = Githubgrab::Helper::remote_file_name(url, res)
+          File.write("#{@destination}/#{file_name}", res.body)
+          puts "- #{file_name} downloaded successfully!".colorize(:green)
+        rescue
+        end
+      end
+    end
+
+    def image_exists url
+      file_name = url.split("/")[-1]
+      result = false
+      if Dir["#{@destination}/*-#{file_name}*"].any?
+        file_timestamp = Dir.glob("#{@destination}/*-#{file_name}*").first.split("/")[-1].split("-").first.to_i
+        result = true if file_timestamp > (Time.now - TIME_VALIDITY).to_i #check if file older than certain amount of time
+      end  
+      result
+    end
+
+  end
+
+end
+  

data/lib/githubgrab/gateway.rb

@@ -0,0 +1,24 @@
+require 'rest-client'
+
+module Githubgrab
+  
+  class Gateway
+    
+    def self.call args
+      begin 
+        response = RestClient.get "https://api.github.com/search/repositories?q=#{args.join('+')}"
+        {body: response.body, code: response.code.to_i}
+      rescue RestClient::ExceptionWithResponse => e
+        {body:  e.response, code: 1000}
+      rescue SocketError
+        {body:  'Network connectivity issue, please check your network', code: 1001} 
+      end
+    end
+
+  end
+
+end
+  
+#TODO: use response.headers[:link].split(",").first.split(";").first[/<(.*)>/,1] to get next link 
+#and add remaining links to response hash. 
+ 

data/lib/githubgrab/helper.rb

@@ -0,0 +1,33 @@
+require "json"
+
+module Githubgrab
+  module Helper
+    def self.extract_image_urls document
+      json = JSON.parse document
+      results = Array.new
+
+      json["items"].each do |element|
+         results << element["owner"]["avatar_url"]
+      end
+      results
+    end
+
+    def self.remote_file_name url, res
+      file_name = Time.now.to_i.to_s + "-" + url.to_s.split('/')[-1]
+      file_name + "." + Githubgrab::Helper::format_name(res.headers[:content_type])
+    end
+
+    def self.format_name content_type
+      case content_type
+      when "image/png"
+        return "png"
+      when "image/jpeg"
+        return "jpeg"
+      when "image/jpg"
+        return "jpg"
+      else
+        return content_type.split('/')[-1]
+      end
+    end
+  end
+end

data/lib/githubgrab/version.rb

@@ -0,0 +1,3 @@
+module Githubgrab
+  VERSION = "0.1.3"
+end

data/lib/githubgrab.rb

@@ -0,0 +1,8 @@
+require "githubgrab/version"
+require "githubgrab/cli"
+require "githubgrab/downloader"
+require "githubgrab/helper"
+
+module Githubgrab
+
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: githubgrab
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- sizief
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thread
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- sizief@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/githubgrab
+- bin/setup
+- githubgrab.gemspec
+- lib/githubgrab.rb
+- lib/githubgrab/cli.rb
+- lib/githubgrab/downloader.rb
+- lib/githubgrab/gateway.rb
+- lib/githubgrab/helper.rb
+- lib/githubgrab/version.rb
+homepage: http://github.com/sizief/gig
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Very simple CLI to download Github profile images
+test_files: []