gh-trending 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 808ee3a7194a4284ee546f7ab167c69ac24439e7
+  data.tar.gz: 0422c8cea905cce431bffcf2ee90df020667725f
+SHA512:
+  metadata.gz: d9b0d3524ea69290beeef5ec6125ae3b63887e1b4f6089af804f8013f023adf0829a9f2ab22b41f6c07a11e67dcc14cd2880e3a9a2c5bef36c542d54f91d65ca
+  data.tar.gz: 8f7e52cc4977c77222b65fed750cefb0344716c9c3105dedd66481a4ba210bcb3a7bd504e46630f543472ed8721d4392f3e6cc944bea53f0542b2c472c523d08

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

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 luispcosta18@gmail.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'
+
+# Specify your gem's dependencies in gh-trending.gemspec
+gemspec
+
+

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Luís Costa
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 luispcosta
+
+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,114 @@
+# Gh::Trending
+
+A simple gem to parse trending repositories and developers from the github's [trending page](https://github.com/trending).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gh-trending'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gh-trending
+
+## Usage
+
+There are two ways of using this gem:
+
+* To fetch trending repositories:
+
+`Gh::Trending::Repositories.new.get(language:, time_period:)`
+
+* To fetch trending developers:
+
+`Gh::Trending::Developers.new.get(language:, time_period:)`
+
+The arguments `language` and `time_period` are provided in hash syntax, and they
+are **not** required. Below there are simplified examples
+
+Accepted values for the `time_period` argument (as of **Jun 2017**):
+
+* `:daily` (default) => Will return the trending developers/repositories in the last day
+* `:weekly` => Will return the trending developers/repositories in the last week
+* `:monthly` => Will return the trending developers/repositories in the last month.
+
+* If you don't provide any value for the `time_period` argument, the value `:daily` is used.
+* If you don't provide any value for the `language` argument, it uses the default github's trending page option, which considers **all languages**.
+* If you provide an unknown `time_period` argument, an error is raised
+* If you don't provide any value for both arguments, this returns the trending developers/repositories for **all languages**, in the **last day**.
+
+### Examples
+
+#### Trending developers
+
+```ruby
+crawler = Gh::Trending::Developers.new
+crawler.get
+# => [
+# <Gh::Trending::Developer:0x00000002f87760
+# @full_name="Dawson Corwin",
+# @hot_repository_url="http://denesiklehner.org/josianne",
+# @user_profile_url="http://hane.co/camren"
+# ,
+# ...
+# ]
+```
+
+* `full_name` => The full name of the developer
+* `hot_repository_url` => The name of the repository that is trending for this developer, in the provided `time_period` and `language`.
+  * In the example above, since no `language` and `time_period` were provided, the repository `"http://denesiklehner.org/josianne"` is the trending repository of this user, since the last day for any language.
+* `user_profile_url` => The github user profile url.
+
+#### Trending repositories
+
+```ruby
+crawler = Gh::Trending::Repositories.new
+crawler.get language: 'javascript'
+# => [#<Gh::Trending::Repository:0x000000035231b0
+ #  @description="Unicode's answer to Base64",
+ #  @language="JavaScript",
+ #  @name="/qntm/base65536",
+ #  @period_stars=104,
+ #  @url="https://github.com/qntm/base65536">,
+ # #<Gh::Trending::Repository:0x00000003511d70
+ #  @description="Prettier is an opinionated JavaScript formatter.",
+ #  @language="JavaScript",
+ #  @name="/prettier/prettier",
+ #  @period_stars=100,
+ #  @url="https://github.com/prettier/prettier">,
+ # ]
+```
+* `description` => The description of the repository
+* `language` => Primary programming language of the repository (should match the one provided in the `language` argument, if provided)
+* `name` => The name of the repository
+* `url` => The github's URL of the repository
+* `period_stars` => The number of stars of the repository in the requested `time_period`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+You can run `bin/dev` to play around with the tool. You should run this command every time you make a change in the gem to test your modifications.
+
+* If for some reason you can't run the `bin/dev` script, make sure the script has executions rights (`chmod +x bin/dev`).
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/luispcosta/gh-trending. 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.
+
+## Tests
+
+To run the test suite:
+
+`rake spec`
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gh_trending"
+require 'pry'
+# 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
+
+pry

data/bin/dev

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+gem build gh-trending.gemspec
+bin/console

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/gh-trending.gemspec

@@ -0,0 +1,44 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gh_trending/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gh-trending"
+  spec.version       = Gh::Trending::VERSION
+  spec.authors       = ["luispcosta"]
+  spec.email         = ["luispcosta18@gmail.com"]
+
+  spec.summary       = %q{Fetch trending repositories/developers from the github's trending page}
+  spec.description   = %q{
+    Fetches the trending repositories and developers from the github's trending page, by time_period
+    and language
+  }
+  spec.homepage      = "https://github.com/luispcosta/gh-trending"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org/"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_dependency "mechanize"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "mechanize"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "faker"
+end

data/lib/gh-trending.rb

@@ -0,0 +1 @@
+require 'gh_trending'

data/lib/gh_trending/developer.rb

@@ -0,0 +1,23 @@
+module Gh
+  module Trending
+    # This class represents a trending developer in the github's trending
+    # developers page.
+    class Developer
+      attr_reader :full_name, :user_profile_url, :hot_repository_url
+
+      def initialize(full_name: nil, user_profile_url: nil, hot_repository_url: nil)
+        @full_name = full_name || ''
+        @user_profile_url = user_profile_url || ''
+        @hot_repository_url = hot_repository_url || ''
+      end
+
+      def to_h
+        {
+          full_name: full_name,
+          user_profile_url: user_profile_url,
+          hot_repository_url: hot_repository_url
+        }
+      end
+    end
+  end
+end

data/lib/gh_trending/developers.rb

@@ -0,0 +1,36 @@
+require 'gh_trending/parsers/parser'
+require 'gh_trending/parsers/developers_parser'
+require 'gh_trending/parsers/parser_arguments'
+require 'gh_trending/developer'
+
+module Gh
+  module Trending
+    class Developers
+      attr_reader :developers_list
+
+      def initialize(parser: nil)
+        @parser = parser || Gh::Trending::Parsers::DevelopersParser.new
+        @developers_list = []
+      end
+
+      def get(*args)
+        parse_args = Gh::Trending::Parsers::ParserArguments.new(*args)
+        developers_list.clear
+        developers_list << parser.parse(parse_args).to_a.compact
+        developers_list.flatten!
+      end
+
+      def [](idx)
+        developers_list[idx]
+      end
+
+      def to_h
+        developers_list.map(&:to_h)
+      end
+
+      private
+
+      attr_reader :parser
+    end
+  end
+end

data/lib/gh_trending/parsers/developers_parser.rb

@@ -0,0 +1,69 @@
+module Gh
+  module Trending
+    module Parsers
+      # Parses the trending developers page
+      class DevelopersParser < Parser
+        LIST_WITH_DEVS_NODES_HTML_CLASS = 'ol.leaderboard-list'.freeze
+        H2_WITH_DEVELOPER_NAME  = 'h2.user-leaderboard-list-name'.freeze
+        ANCHOR_WITH_HOT_REPOSITORY      = 'a.repo-snipit'.freeze
+        SPAN_WITH_FULL_NAME = 'span.full-name'.freeze
+        REGEXP_FOR_FULLNAME = /\((.+)\)/.freeze
+
+        def parse(parser_args)
+          url = build_request_url_with(parser_args)
+          page = agent.get(url)
+          parsed_page = page.at(LIST_WITH_DEVS_NODES_HTML_CLASS)
+
+          raise Gh::Trending::Parsers::HtmlChangedError.new(:front_page_with_devs) if parsed_page.nil?
+          devs = parsed_page.search('li')
+          build_developers_from_node devs
+        end
+
+        def resource_url
+          'https://github.com/trending/developers'.freeze
+        end
+
+        private
+
+        def build_developers_from_node developers_node
+          developers_node.map { |dev_node| Developer.new extract_developer_info dev_node }
+        end
+
+        def extract_developer_info developer_node
+          {
+            full_name: get_full_name(developer_node),
+            hot_repository_url: get_hot_repository_url(developer_node),
+            user_profile_url: get_profile_url(developer_node)
+          }
+        end
+
+        def get_profile_url dev_node
+          parsed_url = dev_node.search(H2_WITH_DEVELOPER_NAME)
+                  .children
+                  .search('a')[0]
+                  .attributes['href']
+                  .value
+          build_github_url(parsed_url)
+        end
+
+        def get_hot_repository_url dev_node
+          parsed_url = dev_node.search(ANCHOR_WITH_HOT_REPOSITORY)[0].attributes['href'].value
+          build_github_url(parsed_url)
+        end
+
+        def get_full_name dev_node
+          span_with_full_name = dev_node.search(SPAN_WITH_FULL_NAME)
+          return nil if span_with_full_name.empty?
+
+          match = span_with_full_name
+                  .text
+                  .strip
+                  .match REGEXP_FOR_FULLNAME
+
+          full_name_without_enclosing_parens = match[1]
+          full_name_without_enclosing_parens
+        end
+      end
+    end
+  end
+end

data/lib/gh_trending/parsers/html_changed_error.rb

@@ -0,0 +1,34 @@
+module Gh
+  module Trending
+    module Parsers
+      # Class indicating that perhaps the HTML of the trending has changed
+      # for whatever reason.
+      #
+      #
+      class HtmlChangedError < StandardError
+        attr_reader :page_that_changed
+
+        def initialize(page_that_changed, msg = nil)
+          @page_that_changed = page_that_changed
+          page_changed_human_format = build_human_format_page_changed
+
+          msg ||= "The page can't be crawled anymore because #{page_changed_human_format} changed its HTML format. Submit a PR to fix it!"
+          super(msg)
+        end
+
+        private
+
+        def build_human_format_page_changed
+          case page_that_changed
+          when :front_page_with_repos
+            "the front page that lists all trending repositories"
+          when :front_page_with_devs
+            "the front page that lists all trending developers"
+          else
+            raise ArgumentError, "Unknown page_that_changed symbol: #{page_that_changed}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gh_trending/parsers/parser.rb

@@ -0,0 +1,49 @@
+require 'mechanize'
+
+module Gh
+  module Trending
+    module Parsers
+      class Parser
+        attr_reader :agent
+
+        def initialize(agent = nil)
+          @agent = agent || default_agent
+        end
+
+        def parse
+          raise NotImplementedError
+        end
+
+        protected
+
+        # Prepends the github's website URL for a given parsed url.
+        # url can be a repository url or a developer url.
+        #
+        # url has the format: /some/url, because that's the format returned to
+        # us by the crawler
+        def build_github_url(url)
+          "https://github.com#{url}"
+        end
+
+        def build_request_url_with(parser_args)
+          return resource_url if parser_args.no_args?
+
+          url = resource_url
+          url += "/#{parser_args.language}" if parser_args.language
+          url += "?since=#{parser_args.time_period}" if parser_args.time_period
+          url
+        end
+
+        def resource_url
+          raise NotImplementedError
+        end
+
+        private
+
+        def default_agent
+          Mechanize.new
+        end
+      end
+    end
+  end
+end

data/lib/gh_trending/parsers/parser_arguments.rb

@@ -0,0 +1,52 @@
+module Gh
+  module Trending
+    module Parsers
+      # This class represents the arguments that both the trending
+      # repositories and languages repositories accept.
+      #
+      # If these pages accept new arguments, just add a new method here
+      # like:
+      #   def new_arg
+      #     args[:arg_name]
+      #   end
+      #
+      # Also, complete the no_args? method.
+      class ParserArguments
+        attr_reader :args
+        UnknownTimePeriod = Class.new(StandardError)
+
+        TIME_PERIOD_ARG = :time_period
+        LANGUAGE_ARG    = :language
+
+        KNOWN_TIME_PERIODS = %i(daily weekly monthly)
+        DEFAULT_TIME_PERIOD = KNOWN_TIME_PERIODS.first
+
+        def initialize(**args)
+          @args = args
+          @args = {} if @args.empty?
+        end
+
+        def time_period
+          sanitize_time_period(args[TIME_PERIOD_ARG])
+        end
+
+        def language
+          args[LANGUAGE_ARG]
+        end
+
+        def no_args?
+          time_period.nil? && language.nil?
+        end
+
+        private
+
+        def sanitize_time_period(time_period)
+          return nil if time_period.nil?
+          raise UnknownTimePeriod.new("The time period '#{time_period}' is invalid. Supported: #{KNOWN_TIME_PERIODS}") unless KNOWN_TIME_PERIODS.include? time_period
+
+          time_period
+        end
+      end
+    end
+  end
+end

data/lib/gh_trending/parsers/repos_parser.rb

@@ -0,0 +1,74 @@
+module Gh
+  module Trending
+    module Parsers
+      # Parses the trending repositories page
+      class ReposParser < Parser
+        LIST_WITH_REPO_NODES_HTML_CLASS = 'ol.repo-list'.freeze
+        DIV_WITH_DESCRIPTION = 'div.py-1'.freeze
+        SPAN_WITH_LANGUAGE = 'span.mr-3'.freeze
+        SPAN_WITH_STARS = 'span.float-right'.freeze
+
+        def parse(parser_args)
+          url = build_request_url_with(parser_args)
+          page = agent.get(url)
+          parsed_page = page.at(LIST_WITH_REPO_NODES_HTML_CLASS)
+
+          raise Gh::Trending::Parsers::HtmlChangedError.new(:front_page_with_repos) if parsed_page.nil?
+          repositories = parsed_page.search('li')
+          build_repositories_from_node(repositories)
+        end
+
+        def resource_url
+          'https://github.com/trending'.freeze
+        end
+
+        private
+
+        def build_repositories_from_node repositories_node
+          repositories_node.map { |repo_node| Repository.new extract_repo_data repo_node }
+        end
+
+        def extract_repo_data repo_node
+          {
+            name:         get_name(repo_node),
+            description:  get_description(repo_node),
+            language:     get_language(repo_node),
+            period_stars: get_stars(repo_node),
+            url:          get_repo_url(repo_node)
+          }
+        end
+
+        def get_name repo_node
+          repo_node.search('h3')[0].children[1].attributes['href'].value
+        end
+
+        def get_description repo_node
+          repo_node.search(DIV_WITH_DESCRIPTION).text.strip
+        end
+
+        def get_language repo_node
+          repo_node.search(SPAN_WITH_LANGUAGE).text.strip
+        end
+
+        def get_stars repo_node
+          string_with_stars = repo_node.search(SPAN_WITH_STARS).text.strip
+          # Github shows the string "1,263 stars this week"
+          # Lets strip only the number.
+          string_with_stars.gsub!(',', '')
+
+          digits_array = string_with_stars.match(/\d+/)
+
+          # Since, after replacing the commans with '', there can only possibly
+          # be one number in the matched data, so we return the first one
+          # and convert it to integer.
+          digits_array.to_a[0].to_i
+        end
+
+        def get_repo_url(repo_node)
+          parsed_url = repo_node.search('h3').children.search('a')[0].attributes['href'].value
+          build_github_url(parsed_url)
+        end
+      end
+    end
+  end
+end

data/lib/gh_trending/repositories.rb

@@ -0,0 +1,37 @@
+require 'gh_trending/parsers/parser'
+require 'gh_trending/parsers/repos_parser'
+require 'gh_trending/parsers/parser_arguments'
+require 'gh_trending/repository'
+require 'gh_trending/parsers/html_changed_error'
+
+module Gh
+  module Trending
+    class Repositories
+      attr_reader :repos_list
+
+      def initialize(parser: nil)
+        @parser = parser || Gh::Trending::Parsers::ReposParser.new
+        @repos_list = []
+      end
+
+      def get(*args)
+        parse_args = Gh::Trending::Parsers::ParserArguments.new(*args)
+        repos_list.clear
+        repos_list << parser.parse(parse_args).to_a.compact
+        repos_list.flatten!
+      end
+
+      def [](idx)
+        repos_list[idx]
+      end
+
+      def to_h
+        repos_list.map(&:to_h)
+      end
+
+      private
+
+      attr_reader :parser
+    end
+  end
+end

data/lib/gh_trending/repository.rb

@@ -0,0 +1,28 @@
+module Gh
+  module Trending
+    # This class represents a trending repository in the github's trending
+    # repositories page.
+    class Repository
+      attr_reader :name, :description, :language, :period_stars, :url
+      # Period stars correspond to the stars that the repository has in the current
+      # period being considered, for example: 283 stars THIS WEEK.
+      def initialize(name: nil, description: nil, language: nil, period_stars: nil, url: nil)
+        @name = name                  || ''
+        @description = description    || ''
+        @language = language          || ''
+        @period_stars = period_stars  || 0
+        @url = url || ''
+      end
+
+      def to_h
+        {
+          name: name,
+          description: description,
+          language: language,
+          period_stars: period_stars,
+          url: url
+        }
+      end
+    end
+  end
+end

data/lib/gh_trending/version.rb

@@ -0,0 +1,5 @@
+module Gh
+  module Trending
+    VERSION = "1.0.0"
+  end
+end

data/lib/gh_trending.rb

@@ -0,0 +1,4 @@
+require 'gh_trending/repository'
+require 'gh_trending/repositories'
+require 'gh_trending/developer'
+require 'gh_trending/developers'

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: gh-trending
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- luispcosta
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: rspec
+  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: mechanize
+  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: pry-byebug
+  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: faker
+  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: "\n    Fetches the trending repositories and developers from the github's
+  trending page, by time_period\n    and language\n  "
+email:
+- luispcosta18@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/dev
+- bin/setup
+- gh-trending.gemspec
+- lib/gh-trending.rb
+- lib/gh_trending.rb
+- lib/gh_trending/developer.rb
+- lib/gh_trending/developers.rb
+- lib/gh_trending/parsers/developers_parser.rb
+- lib/gh_trending/parsers/html_changed_error.rb
+- lib/gh_trending/parsers/parser.rb
+- lib/gh_trending/parsers/parser_arguments.rb
+- lib/gh_trending/parsers/repos_parser.rb
+- lib/gh_trending/repositories.rb
+- lib/gh_trending/repository.rb
+- lib/gh_trending/version.rb
+homepage: https://github.com/luispcosta/gh-trending
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Fetch trending repositories/developers from the github's trending page
+test_files: []