obtenir 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f4dfd49e3a58416aa9a3fa7c882aab2d6a17d601
+  data.tar.gz: 406edcd3418c68038f5929b9f6cd7253389226cb
+SHA512:
+  metadata.gz: 876b64671bc6bd66de11f3c389a4913d9dbaa6d0b9883c4c858f35bbcc3fdd8d1c1be29f817c6120e5eb2960d35e14f06d64a559dff77e450fe7e47de186b868
+  data.tar.gz: d72f3772a12a57dacb9f21725e451e306cf10b4adca662b9f0665377c9358149aa5073237cff6436d64dcbed72ef4aa4cb79259d6c0027880f8ca04aca554134

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.3

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 memuna.haruna@andela.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,13 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in obtenir.gemspec
+gemspec
+gem 'httparty'
+
+gem 'mongo', '~> 2.2'
+
+gem 'bson_ext'
+
+gem 'colorize'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 memuna haruna
+
+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,46 @@
+# Obtenir
+
+* Obtenir prompts users for a valid github username and uses that to fetch the github user's details.
+It gives you the choice of saving the response from github's api to a file or mongodb database.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'obtenir'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install obtenir
+
+## Usage
+
+* To use Obtenir, run:
+```ruby
+Obtenir::Obtenir.get_github_user
+```
+
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/memunaharuna/obtenir. 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(http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Obtenir project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/obtenir/blob/master/CODE_OF_CONDUCT.md).

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 "obtenir"
+
+# 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/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/lib/obtenir/api_request.rb

@@ -0,0 +1,10 @@
+require 'httparty'
+
+module Obtenir
+  class APIRequest
+    def self.fetch(username)
+      HTTParty.get("https://api.github.com/users/#{username}")
+    end
+  end
+end
+

data/lib/obtenir/application.rb

@@ -0,0 +1,54 @@
+module Obtenir
+  class Application
+    def get_username
+      print "Please enter a valid github username: ".colorize(:yellow)
+      @username = gets.strip
+      get_user_details
+    end
+
+    def get_user_details
+      @response = APIRequest.fetch(@username)
+      get_username if @response.message == 'Not Found'
+      process_response
+    end
+
+    def process_response
+      puts "Would you like to save the response?(y/n): ".colorize(:yellow)
+      reply = gets.downcase.strip
+      return if reply == 'n'
+      puts "Where would you like to save this response?".colorize(:yellow)
+      puts "Enter [1] for File, [2] for Database and any other character to exit".colorize(:yellow)
+      decision = gets.strip.to_i
+      save_github_user(decision)
+    end
+
+    def save_github_user(decision)
+      case decision
+        when 1 then save_to_file
+        when 2 then save_to_database
+        else
+          puts "Goodbye!".colorize(:red)
+      end
+    end
+
+    def save_to_file
+      puts "Please provide the absolute path to the file where the response will be saved".colorize(:yellow)
+      file_path = gets.strip
+      if FileOperations.new(file_path, @response).save?
+        puts "Response saved successfully. You can view it here: #{file_path}".colorize(:green)
+      else
+        puts "Directory does not exist".colorize(:red)
+      end
+    end
+
+    def save_to_database
+      puts "Before you proceed, start a mongodb instance by running *mongod* or *sudo mongod* in another terminal".colorize(:red)
+      puts "please enter mongodb database name: ".colorize(:yellow)
+      database = gets.strip.downcase
+      if Database.new(database, @response).save?
+        puts "Response saved in database: #{database.capitalize} successfully.".colorize(:green)
+      end
+    end
+  end
+
+end

data/lib/obtenir/database.rb

@@ -0,0 +1,20 @@
+require 'mongo'
+require 'colorize'
+
+module Obtenir
+  class Database
+    def initialize(database, data)
+      @database = database
+      @data = data
+    end
+
+    def save?
+      client = Mongo::Client.new([ '127.0.0.1:27017' ], :database => @database)
+      collection = client[:people]
+      result = collection.insert_one(@data)
+      true
+    rescue StandardError => error
+      puts "Error: #{error.message} occurred when saving data".colorize(:red)
+    end
+  end
+end

data/lib/obtenir/exit_command.rb

@@ -0,0 +1,6 @@
+module ExitComand
+  def self.exit
+    puts "Enter 0 to exit this program"
+    return if gets.strip.to_i == 0
+  end
+end

data/lib/obtenir/file_operations.rb

@@ -0,0 +1,19 @@
+require 'colorize'
+
+module Obtenir
+  class FileOperations
+    def initialize(file_path, data)
+      @file_path = file_path
+      @data = data
+    end
+
+    def save?
+      f = File.new(@file_path, "w")
+      f.write(@data)
+      f.close
+      true
+    rescue
+      false
+    end
+  end
+end

data/lib/obtenir/version.rb

@@ -0,0 +1,3 @@
+module Obtenir
+  VERSION = "0.1.0"
+end

data/lib/obtenir.rb

@@ -0,0 +1,11 @@
+require_relative "./obtenir/version"
+require 'colorize'
+require_relative './obtenir/api_request'
+require_relative './obtenir/database'
+require_relative './obtenir/file_operations'
+require_relative './obtenir/application'
+
+module Obtenir
+  application = Application.new
+  application.get_username
+end

data/obtenir.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "obtenir/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "obtenir"
+  spec.version       = Obtenir::VERSION
+  spec.authors       = ["memuna haruna"]
+  spec.email         = ["memuna.haruna@andela.com"]
+
+  spec.summary       = "Simple github api consumer"
+  spec.description   = "query github api with their username and save response to file or database"
+  spec.homepage      = "https://github.com/MemunaHaruna/obtenir"
+  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"] = "TODO: Set to 'http://mygemserver.com'"
+  # 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_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: obtenir
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- memuna haruna
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: query github api with their username and save response to file or database
+email:
+- memuna.haruna@andela.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/obtenir.rb
+- lib/obtenir/api_request.rb
+- lib/obtenir/application.rb
+- lib/obtenir/database.rb
+- lib/obtenir/exit_command.rb
+- lib/obtenir/file_operations.rb
+- lib/obtenir/version.rb
+- obtenir.gemspec
+homepage: https://github.com/MemunaHaruna/obtenir
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Simple github api consumer
+test_files: []