gig2 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ca181c7efb3d9ae4d414a6209def1429964464c6e85acee411ca4110550fde9f
+  data.tar.gz: 2c1b9e504e2d847cc4b1f187fef370436866c905ac0d4c8dc4a7399c10731f0d
+SHA512:
+  metadata.gz: c9c59d0d1e8d5cb5ac3c4ff48f829769ff9f465661ae58ea754515ea549f06aaf196711b5afa5df37177ab6f1d5fc86f1136ad2dfa9fbfa86678d012cf5d6975
+  data.tar.gz: b2eef08190673b9de125cac8b8e2c94ff924d606010180aaf56d5d31a36d350e8d7b6f85228e59d817abe3f55ff6a64ecc135f87ad0a70e61c16d7e58b2a4b43

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,21 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gig.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+
+# Library for making http requests
+gem "httparty"
+
+group :development do
+  # Library for debugging using breakpoints
+  gem "pry-byebug"
+end
+
+# Installing gems for testing
+group :test do
+  gem "rspec", "~> 3.0"
+  # Library needed to mock responses
+  gem "webmock"
+end

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    gig2 (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.4.4)
+    hashdiff (1.0.1)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.1104)
+    multi_xml (0.6.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    public_suffix (4.0.4)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    safe_yaml (1.0.5)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gig2!
+  httparty
+  pry-byebug
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  webmock
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Ife Runsewe
+
+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,44 @@
+# Gig
+
+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/gig`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+This gem focuses on github's search api for repositories and downloading repositories's owner images. More information can be found [here](https://docs.github.com/en/free-pro-team@latest/rest/reference/search#search-repositories).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gig'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install gig
+
+## Usage
+
+Once you've installed gig, you should be able to run the gem by executing the following command `bin/gig <argument> <argument>`. You can find out what qualifies as an argument in the [github documentation](https://docs.github.com/en/free-pro-team@latest/rest/reference/search#search-repositories).
+
+Example of a command to run is `bin/gig topic:ruby topic:rails`.
+
+If your response is a good one (status 200) then the program will retrieve each owner of the relative repositories returned and downloach each one's image. These images will be downloaded to
+a directory at the root of this project. The directory's name represents the query you made e.g. from the example above the directory would be called `topic:ruby-topic:rails`.
+
+The github API has a rate limit of no more than 10 requests per second. If this rate limit is hit then you should see a message that explains what has happened and how long till you can make a request. Please find out more [here](https://docs.github.com/en/free-pro-team@latest/rest/reference/search#rate-limit)
+
+You should also see a message if any other status code apart from 200 is returned from the API. Please find out more about which status codes could be returned here [here](https://docs.github.com/en/free-pro-team@latest/rest/reference/search#search-repositories).
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gig"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/gig

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'gig'
+
+gig = Gig::Gig.new(ARGV)
+gig.run

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/gig.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/gig/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gig2"
+  spec.version       = Gig::VERSION
+  spec.authors       = ["Ife Runsewe"]
+  spec.email         = ["iferunsewe@gmail.com"]
+
+  spec.summary       = "This repo allows you to download repository owner's images given a search term"
+  spec.description   = "This repo allows you to download repository owner's images given a search term"
+  spec.homepage      = "http://www.ifesgig.co.uk"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/iferunsewe/gig"
+
+  # 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"]
+end

data/lib/gig.rb

@@ -0,0 +1,6 @@
+require 'httparty'
+require 'open-uri'
+require 'gig/version'
+require 'gig/gig'
+require 'gig/repositories'
+require 'gig/downloader'

data/lib/gig/downloader.rb

@@ -0,0 +1,17 @@
+# A Module to deal with downloading files/images given a path and a uri
+module Gig
+  module Downloader
+    def self.run(directory, filename, uri)
+      Dir.mkdir(directory) unless Dir.exist?(directory)
+
+      path = "#{Dir.pwd}/#{directory}/#{filename}.jpg"
+      return false if File.exist?(path)
+
+      URI.open(path, 'wb') do |file|
+        puts "Downloading #{filename}.jpg to #{Dir.pwd}/#{directory}"
+        file << URI.open(uri).read
+      end
+      true
+    end
+  end
+end

data/lib/gig/gig.rb

@@ -0,0 +1,30 @@
+module Gig
+  class Gig
+    attr_reader :query, :directory, :repositories
+
+    def initialize(args)
+      raise ArgumentError.new('You must provide some arguments to build a search query') if args.count.zero?
+
+      @directory = args.join('-')
+      @query = args.join(' ')
+      @repositories = nil
+    end
+
+    def run
+      puts 'Running gig...'
+      @repositories = intialize_repositories
+      return false unless @repositories.search
+
+      @repositories.owners.each do |response|
+        Downloader.run(directory, response['login'], response['avatar_url'])
+      end
+      true
+    end
+
+    private
+
+    def intialize_repositories
+      Repositories.new(query)
+    end
+  end
+end

data/lib/gig/repositories.rb

@@ -0,0 +1,65 @@
+module Gig
+  class Repositories
+    attr_reader :query, :owners, :response
+    API_PATH = '/search/repositories'.freeze
+
+    def initialize(query)
+      @query = query
+      @owners = []
+      @response = nil
+    end
+
+    def search
+      puts 'Searching for repositories....'
+      request_repositories
+      return handle_ok_response if response.code == 200
+      return !handle_hit_rate_limit if response.code == 403 && rate_limit_hit?
+
+      puts "Status: #{response.code}. Message: #{response.parsed_response['message']}"
+      false
+    end
+
+    private
+
+    def request_repositories
+      @response = HTTParty.get(
+        "https://api.github.com#{API_PATH}",
+        query: {
+          q: query
+        },
+        headers: headers
+      )
+    end
+
+    def headers
+      {
+        'Accept' => 'application/vnd.github.v3+json'
+      }
+    end
+
+    def handle_ok_response
+      puts "Found #{response.parsed_response['total_count']} repositories"
+      return false if response.parsed_response['total_count'].zero?
+
+      @owners = response.parsed_response['items'].map { |item| item['owner'] }
+      true
+    end
+
+    def handle_hit_rate_limit
+      return false unless rate_limit_hit?
+
+      rate_limit_limit = response.headers['x-ratelimit-limit'][0]
+      rate_limit_reset = response.headers['x-ratelimit-reset'][0]
+      time_til_limit_reset = rate_limit_reset - Time.now.to_i
+      puts "You are attempting to make more than #{rate_limit_limit} requests in a minute. " \
+            "This is not allowed so please wait #{time_til_limit_reset} seconds before making the next request. " \
+            "Please find out more information here https://developer.github.com/v3/#rate-limiting"
+      true
+    end
+
+    def rate_limit_hit?
+      rate_limit_remaining = response.headers['x-ratelimit-remaining'][0]
+      rate_limit_remaining.to_i.zero?
+    end
+  end
+end

data/lib/gig/version.rb

@@ -0,0 +1,3 @@
+module Gig
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: gig2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ife Runsewe
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-23 00:00:00.000000000 Z
+dependencies: []
+description: This repo allows you to download repository owner's images given a search
+  term
+email:
+- iferunsewe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/gig
+- bin/setup
+- gig.gemspec
+- lib/gig.rb
+- lib/gig/downloader.rb
+- lib/gig/gig.rb
+- lib/gig/repositories.rb
+- lib/gig/version.rb
+homepage: http://www.ifesgig.co.uk
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: http://www.ifesgig.co.uk
+  source_code_uri: https://github.com/iferunsewe/gig
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: This repo allows you to download repository owner's images given a search
+  term
+test_files: []