ombu_labs-shortener 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1204f8c8cade58cf124ee8528dd9be55034d233fc94c506d3d5932448c24a418
-  data.tar.gz: cd291bb6f406cb733db5a7d136fef4cfb63e27fc923d95cd00f0d71ac8b8a6c0
+  metadata.gz: 1b41c6ce007788b2e45ca15b194d133f2be197becb6ff1155f0936b2607ac4ef
+  data.tar.gz: c756cd79bca5d925b465c327581fcefa09f329fe4e4b3bfe9a074a79f67d9c38
 SHA512:
-  metadata.gz: ded6eb19cf5bfcd4770f00347834c75fd6d4dc96c513c5b255abc0403f468925f0758d4aef1a9c34fc2802bb17b569665464b4f58a0930b08884f33cf6b7919c
-  data.tar.gz: d60dc6c94e5684bab2ec2ce506e5b8178287547d334100e0315210de98d8695fe098290fea1e2a1464019bfbcb40d943d2d345d5ff358ec715edae4f93ba0e9a
+  metadata.gz: 440e33d610fa634ab46e73029413bfd14265d185f50f2e4d8dee8d22b5079e3419e566d92697e6210ef5942c856fef685cc93d97ff04e4348fe5eb1d79fd561c
+  data.tar.gz: e06ac0d425851010e7bb76be5e76cac2850cb665e147d060c0d99dc69f882211e636b0036bea7851b8fa2bb7b244a2e52529ad40846ef1497ab3faa4131024e7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ombulabs-shortener (0.1.0)
+    ombu_labs-shortener (0.1.1)
       rebrandly
 
 GEM
@@ -35,10 +35,11 @@ GEM
 
 PLATFORMS
   x86_64-darwin-19
+  x86_64-linux
 
 DEPENDENCIES
   byebug
-  ombulabs-shortener!
+  ombu_labs-shortener!
   rake (~> 13.0)
   rspec (~> 3.0)
 

data/README.md

@@ -1,22 +1,31 @@
 # OmbuLabs::Shortener
 
-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/ombu_labs/shortener`. To experiment with that code, run `bin/console` for an interactive prompt.
+A short script to shorten links for these domains:
 
-TODO: Delete this and the text above, and describe your gem
+- https://fastruby.io
+- https://ombulabs.com
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+Install the gem:
 
-    $ bundle add ombulabs-shortener
+gem install ombu_labs-shortener
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+## Usage
 
-    $ gem install ombulabs-shortener
+You will need to set up your API key in your environment:
 
-## Usage
+```
+export REBRANDLY_API_KEY=<your api key>
+```
+
+Then you can just call the `shorten` command:
 
-TODO: Write usage instructions here
+```
+shorten https://www.ombulabs.com\?utm_source\=pepe
+Shortening: https://www.ombulabs.com?utm_source=pepe
+Shortened: SHORT: go.ombulabs.com/oxh
+```
 
 ## Development
 
@@ -26,7 +35,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ombulabs-shortener. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/ombulabs-shortener/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/fastruby/ombulabs-shortener. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/fastruby/ombulabs-shortener/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -34,4 +43,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Ombulabs::Shortener project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ombulabs-shortener/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the OmbuLabs::Shortener project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fastruby/ombulabs-shortener/blob/master/CODE_OF_CONDUCT.md).

data/lib/ombu_labs/shortener/cli/application.rb

@@ -16,7 +16,7 @@ class MyCLI
     return puts help if no_api_key?
     return puts invalid_uri if invalid_uri?(args)
 
-    OmbuLabs::Shortener::RebrandlyClient.new(args).shorten
+    OmbuLabs::Shortener::RebrandlyClient.new(args.first).shorten
   end
 
   def self.help

data/lib/ombu_labs/shortener/version.rb

@@ -2,6 +2,6 @@
 
 module OmbuLabs
   module Shortener
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/ombu_labs/shortener.rb

@@ -6,22 +6,43 @@ require_relative "shortener/version"
 module OmbuLabs
   module Shortener
     class RebrandlyClient
-      def initialize(args = [])
-        @url = args.first
+      
+      # You can initialize the client like this:
+      # 
+      # > OmbuLabs::Shortener::RebrandlyClient.new("https://example.com/ombu")
+      #
+      # @param args [String] A valid long URL  
+      def initialize(url)
+        @url = url
         Rebrandly.configure do |config|
           config.api_key = ENV['REBRANDLY_API_KEY']
         end
         @api = Rebrandly::Api.new
       end
 
+      # Shortens the URL and returns a short URL string. It will
+      # NOT raise an exception if there is a communication error with
+      # the Rebrandly API.
+      # 
+      # @return [String]
       def shorten
+        shorten!
+      rescue Rebrandly::RebrandlyError => err
+        puts "Error: #{err.message}"
+        @url
+      end
+
+      # Shortens the URL and returns a short URL string. It will
+      # raise an exception if there is a communication error with
+      # the Rebrandly API.
+      # 
+      # @return [String]
+      def shorten!
         puts "Shortening: #{@url}"
         domain = find_domain
         link = @api.shorten(@url, domain: domain.to_h)
-        puts "Shortened: SHORT: #{link.short_url}"
-
-      rescue Rebrandly::RebrandlyError => err
-        puts "Error: #{err.message}"
+        puts "Shortened: SHORT: https://#{link.short_url}"
+        link.short_url
       end
 
       private
@@ -46,4 +67,4 @@ module OmbuLabs
     class Error < StandardError; end
     # Your code goes here...
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ombu_labs-shortener
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ernesto Tagwerker
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-24 00:00:00.000000000 Z
+date: 2022-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rebrandly
@@ -67,7 +67,7 @@ metadata:
   homepage_uri: https://github.com/fastruby/ombu_labs-shortener
   source_code_uri: https://github.com/fastruby/ombu_labs-shortener
   changelog_uri: https://github.com/fastruby/ombu_labs-shortener/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -82,8 +82,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.21
-signing_key:
+rubygems_version: 3.3.7
+signing_key: 
 specification_version: 4
 summary: One executable to shorten all the long URLs related to OmbuLabs.
 test_files: []