url_shorty 0.0.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 89cbc4dccdf950f2821a1924b53471f1432182f295d610d6fce3ade277f4a3c3
+  data.tar.gz: 745852055b7873d5705745833dcd3e17a747c8dc4ebca4d2b98c0f94f12f8c97
+SHA512:
+  metadata.gz: 3cf7ed0087e287f3299f9fd59c508309e82633bef03c3d74e73a64585df631163f4c6a3302532bd33339fbe693d63722cc837922f0306518f7479c5f2b65b66b
+  data.tar.gz: 3df8316345e1df345deae69252b8951f5ac01b3d04fc12e03bafe2ee1cc8f679f52192dc1583ab97d6f49ff8c6679b86db3b8bc893eaed1d7bdf7c496bcccecd

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.0
+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 TODO: Write your email address. 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,7 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+
+# Specify your gem's dependencies in url_shorty.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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,120 @@
+# UrlShorty
+
+UrlShorty is ruby gem to simplify URL shortening using Google URL shortener. 
+You can refer the gem Documentation [here](http://www.rubydoc.info/gems/url_shorty/0.0.6)
+
+  Using this you can,
+- Shorten a Long URL
+- Expand a Shortened URL
+- Get Analytics details of a Shortened URL. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'url_shorty'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install url_shorty
+
+## Usage
+## Get Google URL Shortener API Key:
+Refer [Google URL Shortener](https://developers.google.com/url-shortener/v1/getting_started) Getting Started page to create a API key for google url Shortener service. 
+
+## Setting up API key:
+
+```ruby
+	UrlShorty.api_key("<Your API KEY>")
+```
+## Shorten URL:
+```ruby
+	UrlShorty.shorten_url("<Long URL>")
+```
+
+**Example:**
+
+```ruby
+	UrlShorty.shorten_url("https://github.com/Balaji-Ramasubramanian/UrlShorty")
+	#=>"https://goo.gl/XojnVs" 
+```
+
+## Expand URL:
+```ruby
+	UrlShorty.expand_url("<Shorten URL>")
+ ```
+
+**Example:**
+```ruby
+	UrlShorty.expand_url("https://goo.gl/XojnVs")
+	#=> "https://github.com/Balaji-Ramasubramanian/UrlShorty"
+ ```
+
+## Get Analytics:
+   To get summary of the analytics for the shortened URL,
+```ruby
+	UrlShorty.get_analytics("<shorten URL>")
+```
+#### Basics Info:
+
+- kind
+- id
+- longUrl
+- status
+- created
+
+**Example:**
+```ruby
+	url_analytics_data = UrlShorty.get_analytics("https://goo.gl/XojnVs")
+	url_analytics_data.kind  	
+	#=> "urlshortener#url"
+	url_analytics_data.id 		
+	#=> "https://goo.gl/XojnVs"
+	url_analytics_data.longUrl 	
+	#=> "https://github.com/Balaji-Ramasubramanian/UrlShorty"
+	url_analytics_data.created 	
+	#=> "2017-11-26T07:26:32.556+00:00"
+
+```
+#### Usage Info:
+Available Scopes:
+- allTime
+- month
+- week
+- twoHours
+
+
+Available information:
+- shortUrlClicks
+- longUrlClicks
+- referers
+- countries
+- browsers
+- platforms
+
+
+**Example**
+```ruby
+	url_analytics_data = UrlShorty.get_analytics("https://goo.gl/SeRtHU")
+	url_analytics_data.analytics.allTime.shortUrlClicks 			
+	#=> "88"
+	url_analytics_data.analytics.allTime.referers[0].count 		
+	#=>"73"
+	url_analytics_data.analytics.month.browsers[1].id 			
+	#=>"Chrome"
+	url_analytics_data.analytics.twoHours.platforms[2].id 		
+	#=>"Macintosh"
+```
+
+
+## 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"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,72 @@
+require "url_shorty/version"
+require "url_shorty/utils"
+require "url_shorty/analytics"
+require 'net/http'
+require 'uri'
+require 'json'
+require 'httparty'
+require 'Openssl'
+
+# @author Balaji
+module UrlShorty
+# @param api_key [String] Google URL Shortener API KEY 
+# @return [nil]
+# This method will set-up the Google URL shortener API key for your project. 
+# If you don't have any API key, { Click here }[https://developers.google.com/url-shortener/v1/getting_started] to create one for your project.
+# Example:
+#
+#     UrlShorty.api_key("<API KEY>")
+#
+def self.api_key (api_key)
+  	@api_key         = api_key
+end
+
+# @param long_url [String] A url value that has to be shortened
+# @return [String] A string representing the shortened URL
+# This method will shorten the provided long URL into a short URL using the Google URL shortener service. 
+# Example:
+#
+#     UrlShorty.shorten_url(""https://github.com/Balaji-Ramasubramanian/UrlShorty")
+#      => "https://goo.gl/XojnVs"
+#
+def self.shorten_url(long_url)
+   uri              = URI.parse( BASE_URL + @api_key )
+   header           = {'Content-Type': 'application/json'}	
+   parameter        = {"longUrl": "#{long_url}"}  
+   http             = Net::HTTP.new(uri.host, uri.port)
+   http.use_ssl     = true
+   http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+   request          = Net::HTTP::Post.new(uri.request_uri, header)
+   request.body     = parameter.to_json
+   response         = http.request(request)
+   data             = JSON.parse(response.body) 
+   if data["id"] != nil then
+    return data["id"]
+   else
+    puts data
+    return data["error"]["errors"][0]["reason"]
+   end
+end
+
+# @param shorten_url [String] A url value that has to be expanded
+# @return [String] A string representing the expanded URL
+# This method will expand the shortened URL into a long URL
+# Example:
+#
+#     UrlShorty.expand_url("https://goo.gl/XojnVs")
+#      => "https://github.com/Balaji-Ramasubramanian/UrlShorty"
+#
+def self.expand_url(shorten_url)
+  	url             = BASE_URL + @api_key + SHORT_URL + shorten_url
+    response        = ""
+    response        = HTTParty.get(url)
+    parsed          = JSON.parse(response.body)
+    long_url            = parsed['longUrl']
+    puts long_url
+    return long_url 
+end
+
+
+    
+end
+

data/lib/url_shorty/analytics.rb

@@ -0,0 +1,61 @@
+require_relative 'utils'
+module UrlShorty
+# @param shorten_url [String] A String represents Shortened URL
+# @return parsed_json_obj [Object] A Object that contains the analytics data of the Shortened URL
+# To get analytics data for Shortened url
+# The basic information about the Shortened URL are,
+#
+#  		- kind
+#  		- id
+#  		- longUrl
+#  		- status
+#  		- created
+#
+# Example:
+#
+#  		url_analytics_data = UrlShorty.get_analytics("https://goo.gl/XojnVs")
+#  		url_analytics_data.kind  	
+#  		=> "urlshortener#url"
+#  		url_analytics_data.id 		
+#  		=> "https://goo.gl/XojnVs"
+#  		url_analytics_data.longUrl 	
+#  		=> "https://github.com/Balaji-Ramasubramanian/UrlShorty"
+#  		url_analytics_data.created 	
+#  		=> "2017-11-26T07:26:32.556+00:00"
+#
+# The Available Scopes are,
+#
+#  		- allTime
+#  		- month
+#  		- week
+#  		- twoHours
+#
+# The Available information
+#      - shortUrlClicks
+#      - longUrlClicks
+#      - referers
+#      - countries
+#      - browsers
+#      - platforms
+#
+# Examples: 
+#
+#  		url_analytics_data = UrlShorty.get_analytics("https://goo.gl/SeRtHU")
+#  		url_analytics_data.analytics.allTime.shortUrlClicks 			
+#  		=> "88"
+#  		url_analytics_data.analytics.allTime.referers[0].count 		
+#  		=>"73"
+#  		url_analytics_data.analytics.month.browsers[1].id 			
+#  		=>"Chrome"
+#  		url_analytics_data.analytics.twoHours.platforms[2].id 		
+#  		=>"Macintosh"
+#
+def self.get_analytics (shorten_url)
+    url             = BASE_URL + @api_key + SHORT_URL + shorten_url + PROJECTION
+    response        = ""
+    response        = HTTParty.get(url)
+    parsed_json_obj         = JSON.parse(response.body, object_class: OpenStruct)
+    return parsed_json_obj
+end
+	   
+end

data/lib/url_shorty/utils.rb

@@ -0,0 +1,5 @@
+module UrlShorty
+		BASE_URL = "https://www.googleapis.com/urlshortener/v1/url?key="
+		SHORT_URL = "&shortUrl="
+		PROJECTION = "&projection=FULL"
+end

data/lib/url_shorty/version.rb

@@ -0,0 +1,3 @@
+module UrlShorty
+  VERSION = "0.0.12"
+end

data/url_shorty.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "url_shorty/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "url_shorty"
+  spec.version       = UrlShorty::VERSION
+  spec.authors       = ["Balaji"]
+  spec.email         = ["balaji030698@gmail.com"]
+
+  spec.summary       = %q{This is a google url shortener tool for ruby users.}
+  spec.description   = %q{By using this gem we can able to shorten a URL
+                        and also able to expand the Short URLs.}
+  spec.homepage      = "https://github.com/balaji12345/UrlShorty"
+  spec.license       = "MIT"
+  spec.files = ['lib/url_shorty/analytics.rb',
+                'lib/url_shorty/utils.rb',
+                'lib/url_shorty/version.rb']
+  # 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_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_runtime_dependency "json", "~> 2.0.2"
+  spec.add_runtime_dependency "httparty", "~> 0.15.6"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: url_shorty
+version: !ruby/object:Gem::Version
+  version: 0.0.12
+platform: ruby
+authors:
+- Balaji
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-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.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.6
+description: |-
+  By using this gem we can able to shorten a URL
+                          and also able to expand the Short URLs.
+email:
+- balaji030698@gmail.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/url_shorty.rb
+- lib/url_shorty/analytics.rb
+- lib/url_shorty/utils.rb
+- lib/url_shorty/version.rb
+- url_shorty.gemspec
+homepage: https://github.com/balaji12345/UrlShorty
+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.7.2
+signing_key: 
+specification_version: 4
+summary: This is a google url shortener tool for ruby users.
+test_files: []