universities 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e17c80ae38373129710744282dd2aeeaabbfd118
+  data.tar.gz: f513351f3cd6491724ae9d9dd682febd74dd2796
+SHA512:
+  metadata.gz: 114c1bec9835c07b2fc068320e8a56f69e12459315e57b791c50bdc5c24991688a5a96f88f72d1401b6160d1189f6fe53bbb2d98a493ead5f69b6bb175c5a553
+  data.tar.gz: 3b765c1a6f25739d976008dc84d5e88d041e98fc749d4c5f9bd428ddec22e840fc5e73d339d981f8a45af4dc23855225f869e1937c6cc4189d32550609953ca2

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/.rubocop.yml

@@ -0,0 +1,6 @@
+Metrics/LineLength:
+  Max: 120
+Style/Documentation:
+  Enabled: false
+Layout/EndOfLine:
+  Enabled: false

data/.travis.yml

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

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 florin@floringorgan.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 universities.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    universities (0.1.0)
+      activesupport
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.4)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.3.8)
+    httparty (0.16.4)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.5.3)
+      concurrent-ruby (~> 1.0)
+    method_source (0.8.2)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
+    minitest (5.11.3)
+    multi_xml (0.6.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.5)
+    slop (3.6.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    vcr (4.0.0)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  universities!
+  vcr
+  webmock
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Florinel Gorgan
+
+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,87 @@
+[![Build Status](https://travis-ci.org/laurentzziu/universities.svg?branch=master)](https://travis-ci.org/laurentzziu/universities)
+
+# Universities
+
+This is a Ruby gem for querying [Hipo/university-domains-list](https://github.com/Hipo/university-domains-list).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'universities'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install universities
+
+## Usage
+
+### Get all universities
+```ruby
+# returns an array with all Universities
+# each element is an instance of Universities::Entity
+Universities.get_all
+```
+
+### Filter
+Available filters: `country`, `name`.
+
+**Important!** In order for the filtered request to return results, you need to call `#fetch`.
+
+#### Filter by *country*
+```ruby
+Universities.get.country('Romania').fetch
+# alias_method: 
+Universities.get.by_country('Romania').fetch
+```
+
+#### Filter by *name*
+```ruby
+Universities.get.name('Politehnica').fetch
+# alias_method: 
+Universities.get.by_name('Politehnica').fetch
+```
+
+#### Filter by *country* and *name*
+```ruby
+Universities.get.country('Romania').name('Politehnica').fetch
+# alias_method: 
+Universities.get.by_country('Romania').by_name('Politehnica').fetch
+```
+
+#### University::Entity 
+Example
+
+```ruby
+#<Universities::Entity:0x00007fbd4312c408
+  @alpha_two_code="RO",
+  @country="Romania",
+  @domains=["pub.ro"],
+  @name="University Politehnica of Bucharest",
+  @state_province=nil,
+  @web_pages=["http://www.pub.ro/"]>
+```
+
+## 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/laurentzziu/universities>. 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 Universities project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/laurentzziu/universities/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :console do
+  exec "pry -r universities -I ./lib"
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "universities"
+
+# 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/universities.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'universities/version'
+
+require 'universities/up_dupable'
+require 'universities/request'
+require 'universities/entity'
+
+module Universities
+  def self.get
+    Request.new
+  end
+
+  def self.get_all
+    Request.new.fetch
+  end
+end

data/lib/universities/entity.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+require 'active_support/core_ext/hash'
+
+module Universities
+  class Entity
+    ATTRIBUTES_MAPPING = {
+      web_pages: 'web_pages',
+      alpha_two_code: 'alpha_two_code',
+      state_province: 'state-province',
+      country: 'country',
+      domains: 'domains',
+      name: 'name'
+    }
+
+    def initialize(web_pages: nil, alpha_two_code: nil, state_province: nil, country: nil, domains: nil, name: nil)
+      local_variables.each do |key|
+        self.class.class_eval do
+          attr_reader key
+        end
+        value = eval(key.to_s)
+        instance_variable_set("@#{key}", value)
+      end
+    end
+
+    def self.build(hash)
+      new(**parse_attributes(hash))
+    end
+
+    def self.parse_attributes(hash)
+      hash = hash.with_indifferent_access
+      ATTRIBUTES_MAPPING.map do |attribute, hash_key|
+        [attribute, hash.dig(hash_key)]
+      end.to_h
+    end
+  end
+end

data/lib/universities/request.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'httparty'
+
+module Universities
+  class Request
+    include HTTParty
+    include UpDupable
+
+    def initialize(country: nil, name: nil)
+      @country = country
+      @name = name
+    end
+
+    def fetch
+      response = HTTParty.get(BASE_URL, query: params)
+      response.parsed_response.map do |hash|
+        Entity.build(hash)
+      end
+    end
+
+    def country(word)
+      dup_and_update(country: word)
+    end
+
+    alias_method :by_country, :country
+
+    def name(word)
+      dup_and_update(name: word)
+    end
+
+    alias_method :by_name, :name
+
+    private
+
+    BASE_URL = 'http://universities.hipolabs.com/search'
+
+    def params
+      hash = {}
+      hash[:country] = country_params if @country
+      hash[:name] = name_params if @name
+      hash
+    end
+
+    def country_params
+      sanitize_string(@country) if @country
+    end
+
+    def name_params
+      sanitize_string(@name) if @name
+    end
+
+    def sanitize_string(string)
+      string.gsub(/\s+/, '+')
+    end
+  end
+end

data/lib/universities/up_dupable.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# From https://gist.github.com/eliav-lavi/1b739bc57719bd9755f2dee3f5a02cef#file-up_dupable-rb
+# by Eliav Lavi (https://github.com/eliav-lavi)
+module UpDupable
+  def dup_and_update(**args)
+    self.class.new(clean_ivars.merge(args))
+  end
+
+  private
+
+  def clean_ivars
+    instance_variables_get.each_with_object({}) { |(k, v), hash| hash[k.to_s.delete('@').to_sym] = v }
+  end
+
+  def instance_variables_get
+    instance_variables.each_with_object({}) { |ivar, hash| hash[ivar] = instance_variable_get(ivar) }
+  end
+end

data/lib/universities/version.rb

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

data/universities.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'universities/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'universities'
+  spec.version       = Universities::VERSION
+  spec.authors       = ['Florinel Gorgan']
+  spec.email         = ['florin@floringorgan.com']
+
+  spec.summary       = %q(Ruby gem for Hipo/university-domains-list.)
+  spec.description   = %q(Ruby gem for Hipo/university-domains-list.)
+  spec.homepage      = 'https://github.com/laurentzziu/universities'
+  spec.license       = 'MIT'
+
+  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_runtime_dependency 'httparty'
+  spec.add_runtime_dependency 'activesupport'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: universities
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Florinel Gorgan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: activesupport
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: 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'
+description: Ruby gem for Hipo/university-domains-list.
+email:
+- florin@floringorgan.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/universities.rb
+- lib/universities/entity.rb
+- lib/universities/request.rb
+- lib/universities/up_dupable.rb
+- lib/universities/version.rb
+- universities.gemspec
+homepage: https://github.com/laurentzziu/universities
+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.14
+signing_key: 
+specification_version: 4
+summary: Ruby gem for Hipo/university-domains-list.
+test_files: []