ruby-bitly 0.2.1 → 3.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d1771cca1a80ce56b33cfb9578d3bd378f0ce83c
-  data.tar.gz: c0fffae72cbab2491b2bb4a5688f192b6d48af00
+SHA256:
+  metadata.gz: bc2319a77b8e27a1232ec307d0340da712918cc5a1e7debbd0de2c4bc48c24b5
+  data.tar.gz: 35f06c843599ba7176f1509475633357720b324b1eddb4f411b8740f531bde85
 SHA512:
-  metadata.gz: ed38e9827405f2463b37377ed955801c8f4be6173f418e83b777feacc4f123f150f8cad56f0f0cdbe2f30af80bf7ef33106586bdea31cac9fc8dc49a66f6e616
-  data.tar.gz: 9d3ecf027d2a2bf44786337415ce1ae88e565b00507c037d5787a3092d64bb4f81045ecf431446b7b8063ab75f9d8a81ffd0bfe60e44be09918dfb129e467f08
+  metadata.gz: dab564991fac44286a064b29be9b83d0a9ab1e28c25e3ee6fa9710b54acefd599615dc03a49764eb57d9c9882fb5f3ab70a48ad11657032e6363d70d24b2bf51
+  data.tar.gz: 5942d8c6baeda9d0301d48955f08a93ec082a8937449c726bd01ddc2f995299e40094359c019fe408df5c1fbe09564be970a0c5d73513ae0ac3774e289b66aac

data/.travis.yml

@@ -1,7 +1,17 @@
 language: ruby
+before_install:
+  - gem install rubygems-update -v '<3' && update_rubygems
+gemfile:
+  - gemfiles/rest-client-2.1.0.rc1.gemfile
+  - gemfiles/rest-client-2.0.2.gemfile
+  - gemfiles/rest-client-2.0.1.gemfile
+script:
+  - bundle exec rake spec
 rvm:
-  - 2.0.0
+  - 2.6.3
+  - 2.5.5
+  - 2.4.6
+  - 2.3.8
+  - 2.2.10
   - 2.1.10
-  - 2.2.5
-  - 2.3.1
-  - 2.4.0
+  - 2.0.0

data/CHANGELOG

@@ -1,4 +1,15 @@
+# 3.0.0.rc1 - BREAKING CHANGES!
+
+- Update README with all updates and breaking changes. Check it out!
+- Remove the first zero when bumping version: 0.2.1 => 3.0.0
+- Remove deprecated API
+- Rename method `hash_path` to `user_hash`
+- Rename boolean method `new_hash` to `new_hash?`
+- Add attributes `success?` and `error?` to better error handling
+- Remove old attributes `status_code` and `status_txt`
+
 # 0.2.1
+
 - Add support for ruby 2.4.0
 - Add support for set domain on command line
 - Remove feature 'copy to clipboard' on command line

data/Gemfile.lock

@@ -7,15 +7,14 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.0)
-      public_suffix (~> 2.0, >= 2.0.2)
-    byebug (9.0.6)
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
     domain_name (0.5.20170223)
       unf (>= 0.0.5, < 1.0.0)
-    hashdiff (0.3.2)
+    hashdiff (0.3.9)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
     mime-types (3.1)
@@ -23,44 +22,46 @@ GEM
     mime-types-data (3.2016.0521)
     netrc (0.11.0)
     public_suffix (2.0.5)
-    rake (12.0.0)
+    rake (12.3.2)
     rest-client (2.0.1)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.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.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
-    safe_yaml (1.0.4)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.5)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.2)
-    vcr (3.0.3)
-    webmock (2.3.2)
+    vcr (4.0.0)
+    webmock (3.5.1)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
+    wwtd (1.3.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  byebug
+  public_suffix (< 3)
   rake
-  rspec (~> 3.5)
+  rspec
   ruby-bitly!
-  vcr (~> 3.0)
-  webmock (~> 2.1)
+  vcr
+  webmock
+  wwtd
 
 BUNDLED WITH
-   1.14.6
+   1.17.3

data/README.rdoc

@@ -13,8 +13,7 @@
 
   Bitly.config do |c|
     c.login   = 'login-here'
-    c.api_key = 'key-here'
-    c.key     = 'key-here' # deprecated: use api_key instead
+    c.api_key = 'api-key-here'
     c.use_ssl = false # read more below
     c.proxy   = 'http://localhost:8888' # read more below
   end
@@ -22,8 +21,7 @@
   Or set them individualy:
 
   Bitly.login   = 'login-here'
-  Bitly.api_key = 'key-here'
-  Bitly.key     = 'key-here' # deprecated: use api_key instead
+  Bitly.api_key = 'api-key-here'
   Bitly.use_ssl = false # read more below
   Bitly.proxy   = 'http://localhost:8888' # read more below
 
@@ -31,77 +29,54 @@
 
 
 == Shorten
-  # old way
-  bitly = Bitly.shorten("https://dx7.github.io/")
+  bitly = Bitly.shorten(long_url: "https://dx7.github.io/")
 
-  # old way setting local configuration
-  bitly = Bitly.shorten("https://dx7.github.io/", "login-here", "key-here")
-
-  # new way
-  bitly = Bitly.shorten(url: "https://dx7.github.io/")
-
-  # new way setting local configuration
-  bitly = Bitly.shorten(url: "https://dx7.github.io/", login: "login-here", api_key: "key-here", domain: "my.do")
+  # setting credentials
+  bitly = Bitly.shorten(long_url: "https://dx7.github.io/", domain: "my.do", login: "login-here", api_key: "api-key-here")
 
   # result
-  bitly.url #=> "http://bit.ly/2dAjjfo"
-
-  y bitly
-    :long_url: http://dx7.github.io/
-    :url: http://bit.ly/2dAjjfo
-    :hash: 2dAjjfo
-    :global_hash: micSj7
-    :new_hash: 0
-    :hash_path: 2dAjjfo
-    :status_code: 200
-    :status_txt: OK
+  bitly.short_url   #=> "http://bit.ly/2dAjjfo"
+  bitly.long_url    #=> "https://dx7.github.io/"
+  bitly.new_hash?   #=> true
+  bitly.global_hash #=> "2dAkyet"
+  bitly.user_hash   #=> "2dAjjfo"
+  bitly.success?    #=> true
 
 
 == Expand
-  # old way
-  bitly = Bitly.expand("http://bit.ly/2dAjjfo")
-
-  # old way setting local configuration
-  bitly = Bitly.expand("http://bit.ly/2dAjjfo", "login-here", "key-here")
+  bitly = Bitly.expand(short_url: "http://bit.ly/2dAjjfo")
 
-  # new way
-  bitly = Bitly.expand(url: "http://bit.ly/2dAjjfo")
-
-  # new way setting local configuration
-  bitly = Bitly.expand(url: "http://bit.ly/2dAjjfo", login: "login-here", api_key: "key-here")
+  # setting credentials
+  bitly = Bitly.expand(short_url: "http://bit.ly/2dAjjfo", login: "login-here", api_key: "api-key-here")
 
   # result
-  y bitly
-    :short_url: http://bit.ly/2dAjjfo
-    :long_url: https://dx7.github.io/
-    :user_hash: 2dAjjfo
-    :global_hash: 2dAkyet
-    :status_code: 200
-    :status_txt: OK
+  bitly.short_url   #=> "http://bit.ly/2dAjjfo"
+  bitly.long_url    #=> "https://dx7.github.io/"
+  bitly.global_hash #=> "2dAkyet"
+  bitly.user_hash   #=> "2dAjjfo"
+  bitly.success?    #=> true
 
 
 == Get Clicks
-  # old way
-  bitly = Bitly.get_clicks("http://bit.ly/2dAjjfo")
+  bitly = Bitly.get_clicks(short_url: "http://bit.ly/2dAjjfo")
+
+  # setting credentials
+  bitly = Bitly.get_clicks(short_url: "http://bit.ly/2dAjjfo", login: "login-here", api_key: "api-key-here")
 
-  # old way setting local configuration
-  bitly = Bitly.get_clicks("http://bit.ly/2dAjjfo", "login-here", "key-here")
+  # result
+  bitly.short_url      #=> "http://bit.ly/2dAjjfo"
+  bitly.user_hash      #=> "2dAjjfo"
+  bitly.global_hash    #=> "2dAkyet"
+  bitly.user_clicks    #=> 0
+  bitly.global_clicks  #=> 1
+  bitly.success?       #=> true
 
-  # new way
-  bitly = Bitly.get_clicks(url: "http://bit.ly/2dAjjfo")
 
-  # new way setting local configuration
-  bitly = Bitly.get_clicks(url: "http://bit.ly/2dAjjfo", login: "login-here", api_key: "key-here")
+== Error handling
 
-  # result
-  y bitly
-    :short_url: https://bit.ly/2dAjjfo
-    :global_hash: 2dAkyet
-    :user_clicks: 0
-    :user_hash: 2dAjjfo
-    :global_clicks: 0
-    :status_code: 200
-    :status_txt: OK
+  # if something goes wrong you can check
+  bitly.success? #=> false
+  bitly.error    #=> 'INVALID_LOGIN'
 
 
 == Proxy
@@ -119,10 +94,20 @@
 
 
 == Command Line
-  Usage
-    bitly [options] url
+  Usage: bitly [options] URL
+    -l, --login LOGIN                You need a free Bitly login and api key. Sign up here: http://bit.ly/a/sign_up.
+    -k, --api-key KEY                You can find your api key here: http://bit.ly/a/your_api_key.
 
-    For help: bitly -h
+    -d, --domain DOMAIN              The short domain to use: either bit.ly, j.mp, bitly.com or a custom short domain.
+                                     This option will override the default short domain selected in your Bitly account settings.
+
+    -s, --shorten                    Given a long URL, returns a Bitlink.
+    -e, --expand                     Given a Bitlink, hash or custom path, returns the target (long) URL.
+    -u, --user-clicks                The total count of clicks to this user's Bitlink.
+    -g, --global-clicks              The total count of the corresponding Bitly aggregate hash.
+
+    -h, --help                       Print this help.
+    -v, --version                    Print version.
 
   Basic examples:
     bitly -s http://dx7.github.io
@@ -130,37 +115,16 @@
     bitly --user-clicks http://bit.ly/2dAjjfo
     bitly --global-clicks http://bit.ly/2dAjjfo
 
-  Other examples:
-    bitly -q -s http://dx7.github.io
-    bitly --verbose -e http://bit.ly/2dAjjfo
-
-  Options
-    -s, --shorten        Shorten a long url (default option)
-    -e, --expand         Expand a short bitly url
-    -u, --user-clicks    Show user clicks from the short bitly url
-    -g, --global-clicks  Show global clicks from the short bitly url
-
-    -l, --login LOGIN    Your bit.ly login
-    -k, --key KEY        Your bit.ly API key
-
-    -h, --help           Displays help message, then exit
-    -v, --version        Display the version, then exit
-    -q, --quiet          Output as little as possible, overrides verbose
-    -V, --verbose        Verbose output
-
 
 == Authentication
   bit.ly API requires authentication credentials.
 
-  You'll need a free bit.ly login and apiKey. Sign up here: http://bit.ly/a/sign_up
-  If you've already signed up, you can find your apiKey here: http://bit.ly/a/your_api_key
-
   Using commmand line you can supply credentials as parameters. For example:
-    bitly -l <login-here> -k <key-here> -s http://dx7.github.io
+    bitly -l <login-here> -k <api-key-here> -s http://dx7.github.io
 
   Or you can create the file ~/.bitly (YAML format) with that content:
     login: <login-here>
-    key: <key-here>
+    api_key: <api-key-here>
 
 
 == Author

data/Rakefile

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

data/bin/bitly

@@ -13,106 +13,52 @@ class App
 
   attr_accessor :arguments, :options
 
-  def initialize(arguments, stdin = nil)
-    self.options = OpenStruct.new
+  def initialize(arguments)
     self.arguments = arguments
-    @stdin = stdin
+    self.options = OpenStruct.new
   end
 
   def run
+    load_account_data
     process_options
-
-    if arguments_valid?
-      output_options if options.verbose
-
-      post_process_options and process_arguments
-
-      result = process_command
-
-      puts "#{options.message} #{result}".strip
-    else
-      output_help("ERROR: Invalid options", 'examples')
-    end
+    puts process_command
   end
 
   protected
 
     def load_account_data
-      begin
-        account_data = YAML.load(File.read(ACCOUNT_FILE_PATH))
-      rescue
-        output_help("ERROR: Crendentials not found", 'authentication')
-      end
-
-      if account_data
-        options.login = account_data["login"]
-        options.key = account_data["key"]
-      end
-    end
-
-    def default_options
-      options.verbose = false
-      options.quiet = false
+      account_data = YAML.load(File.read(ACCOUNT_FILE_PATH)) rescue {}
+      options.login = account_data['login']
+      options.api_key = account_data['api_key']
+    rescue
     end
 
     def process_options
-      default_options
-
-      opts = OptionParser.new
-
-      opts.on('-s', '--shorten')       { options.shorten = true; options.message = 'Short url:' }
-      opts.on('-e', '--expand')        { options.expand = true; options.message = 'Original url:' }
-      opts.on('-u', '--user-clicks')   { options.user_clicks = true; options.message = 'User clicks:' }
-      opts.on('-g', '--global-clicks') { options.global_clicks = true; options.message = 'Global clicks:' }
-
-      opts.on('-l', '--login LOGIN')   { |login| options.login = login }
-      opts.on('-k', '--key KEY')       { |key| options.key = key }
-      opts.on('-d', '--domain DOMAIN') { |domain| options.domain = domain }
-
-      opts.on('-v', '--version')    { output_version ; exit 0 }
-      opts.on('-h', '--help')       { output_help }
-      opts.on('-V', '--verbose')    { options.verbose = true }
-      opts.on('-q', '--quiet')      { options.quiet = true; options.verbose = false }
-
-      opts.parse!(arguments) rescue return false
-    end
-
-    def post_process_options
-      # Bitly API Login / Key
-      load_account_data unless options.login and options.key
-
-      # Default option: --shorten
-      options.shorten = true and options.message = 'Short url:' unless options.expand or options.user_clicks or options.global_clicks
-
-      # Message empty if option quiet exists
-      options.message = '' if options.quiet
-    end
+      OptionParser.new do |opts|
+        opts.banner = "Usage: bitly [options] URL"
 
-    def output_options
-      puts "Options:\n"
-
-      options.marshal_dump.each do |name, val|
-        puts "  #{name} = #{val}"
-      end
-
-      puts "  URL: #{arguments.first}\n"
-    end
+        opts.on('-l', '--login LOGIN', 'You need a free Bitly login and api key. Sign up here: http://bit.ly/a/sign_up.') do |login|
+          options.login = login
+        end
 
-    def arguments_valid?
-      arguments.length == 1
-    end
+        opts.on('-k', '--api-key KEY', 'You can find your api key here: http://bit.ly/a/your_api_key.', ' ') do |api_key|
+          options.api_key = api_key
+        end
 
-    def process_arguments
-    end
+        opts.on('-d', '--domain DOMAIN',
+                'The short domain to use: either bit.ly, j.mp, bitly.com or a custom short domain.',
+                'This option will override the default short domain selected in your Bitly account settings.', ' ') do |domain|
+          options.domain = domain
+        end
 
-    def output_help(message = nil, section = "")
-      puts message if message
+        opts.on('-s', '--shorten', 'Given a long URL, returns a Bitlink.') { options.command = :shorten }
+        opts.on('-e', '--expand', 'Given a Bitlink, hash or custom path, returns the target (long) URL.') { options.command = :expand }
+        opts.on('-u', '--user-clicks', 'The total count of clicks to this user\'s Bitlink.')   { options.command = :user_clicks }
+        opts.on('-g', '--global-clicks', 'The total count of the corresponding Bitly aggregate hash.', ' ') { options.command = :global_clicks }
 
-      File.open(File.join(File.dirname(__FILE__), '..', 'README.rdoc'), "r") do |infile|
-        while (line = infile.gets)
-          puts line
-        end
-      end
+        opts.on('-h', '--help', 'Print this help.') { puts opts.help; exit 0 }
+        opts.on('-v', '--version', 'Print version.') { output_version; exit 0 }
+      end.parse!
     end
 
     def output_version
@@ -120,13 +66,19 @@ class App
     end
 
     def process_command
-      return Bitly.shorten(url: arguments.first, login: options.login, api_key: options.key, domain: options.domain).url if options.shorten && options.domain
-      return Bitly.shorten(url: arguments.first, login: options.login, api_key: options.key).url if options.shorten
-      return Bitly.expand(url: arguments.first, login: options.login, api_key: options.key).long_url if options.expand
-      return Bitly.get_clicks(url: arguments.first, login: options.login, api_key: options.key).user_clicks.to_s if options.user_clicks
-      return Bitly.get_clicks(url: arguments.first, login: options.login, api_key: options.key).global_clicks.to_s if options.global_clicks
+      case options.command
+      when :shorten
+        Bitly.shorten(long_url: arguments.first, login: options.login, api_key: options.api_key, domain: options.domain).short_url
+      when :expand
+        Bitly.expand(short_url: arguments.first, login: options.login, api_key: options.api_key).long_url
+      when :user_clicks
+        Bitly.get_clicks(short_url: arguments.first, login: options.login, api_key: options.api_key).user_clicks.to_s
+      when :global_clicks
+        Bitly.get_clicks(short_url: arguments.first, login: options.login, api_key: options.api_key).global_clicks.to_s
+      else
+        "No command given"
+      end
     end
 end
 
-app = App.new(ARGV)
-app.run
+App.new(ARGV).run