bitly 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f5ca773433a54eb91817b7a7167b625d04cb33701afbb97a5bc4df3831dd429
-  data.tar.gz: 8b97a419154acad1eeb030c8f918c85022ad7a607db44d379cc0ef4cf4f737f7
+  metadata.gz: e0a2dd617bd9c23263a1db205f8ea95359c34273df7eecc5ca9565536a03c802
+  data.tar.gz: 4f0dac7f35a238a61b9ec36390df824170b576f15e8f111203bf83a8f600993d
 SHA512:
-  metadata.gz: 52a578ae00f4b4d1016202cb9212fbf8af3fbc1b8d99161b03fe7f97dd383677bdf6f867ff44d19575e566932727e932ba06d8c39883a2a2ff48daec968b5525
-  data.tar.gz: 73053a5be2a75f261d1036893e1e3159abc822829455fa890956cfb8818c08c57d5000dcdcf8d32719c156d65a52b7d26ab8de046f202c7ceb120f0cdae39b22
+  metadata.gz: cc10e4a46caeb7155292380f8c61feec74cf19ce9da36ee49c9b7dbff763b5c4703b58c9e2ded557cfb6426fa7f68532914a49350bc9f5e4f8c25a57ff7d3e82
+  data.tar.gz: 1935c386fc1d489a532de2459222f9a069a3a6f0a258d58178c16694e131d8be246226464fe1f2f83a40db1c333c0422d1c60905c0ec1dfb23492ae927db2c93

data/.github/workflows/sonarcloud.yml

@@ -0,0 +1,34 @@
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, synchronize, reopened]
+name: SonarCloud Analysis
+jobs:
+  sonarcloud:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          # Disabling shallow clone is recommended for improving relevancy of reporting
+          fetch-depth: 0
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.1"
+      - name: "Install dependencies"
+        run: bundle install
+      - name: Run tests for coverage
+        run: bundle exec rspec
+        env:
+          COVERAGE: json
+      - name: fix code coverage paths
+        working-directory: ./coverage
+        run: |
+          sed -i 's@'$GITHUB_WORKSPACE'@/github/workspace/@g' coverage.json
+      - name: SonarCloud Scan
+        uses: sonarsource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

data/History.txt

@@ -2,6 +2,12 @@
 
 ...
 
+=== 2.1.0 / 2022-10-21
+
+* Strips protocol from the start of a bitlink when fetching/expanding (fixes #80)
+* Adds SonarCloud quality check GitHub Action
+* Uses verifying doubles in tests over generic doubles
+
 === 2.0.2 / 2022-10-18
 
 * Allows oauth2 gem version 2

data/README.md

@@ -2,7 +2,7 @@
 
 A Ruby gem for using the version 4 [Bitly API](https://dev.bitly.com/) to shorten links, expand short links and view metrics across users, links and organizations.
 
-[![Gem version](https://badge.fury.io/rb/bitly.svg)](https://rubygems.org/gems/bitly) ![Build status](https://github.com/philnash/bitly/workflows/tests/badge.svg) [![Maintainability](https://api.codeclimate.com/v1/badges/f8e078b468c1f2aeca53/maintainability)](https://codeclimate.com/github/philnash/bitly/maintainability) [![Inline docs](https://inch-ci.org/github/philnash/bitly.svg?branch=master)](https://inch-ci.org/github/philnash/bitly)
+[![Gem version](https://badge.fury.io/rb/bitly.svg)](https://rubygems.org/gems/bitly) ![Build status](https://github.com/philnash/bitly/workflows/tests/badge.svg) [![Maintainability](https://api.codeclimate.com/v1/badges/f8e078b468c1f2aeca53/maintainability)](https://codeclimate.com/github/philnash/bitly/maintainability) [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=philnash_bitly&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=philnash_bitly) [![Inline docs](https://inch-ci.org/github/philnash/bitly.svg?branch=master)](https://inch-ci.org/github/philnash/bitly)
 
 * [Installation](#installation)
 * [Usage](#usage)

data/bitly.gemspec

@@ -35,7 +35,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "simplecov", "~> 0.17.1"
+  spec.add_development_dependency "simplecov", "~> 0.21"
+  spec.add_development_dependency "simplecov_json_formatter", "~> 0.1"
   spec.add_development_dependency "webmock", "~> 3.7.6"
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "envyable"

data/lib/bitly/api/bitlink/clicks_summary.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require_relative "../base"
+require_relative "./utils"
 
 module Bitly
   module API
@@ -8,6 +9,7 @@ module Bitly
         include Base
 
         def self.fetch(client:, bitlink:, unit: nil, units: nil, unit_reference: nil, size: nil)
+          bitlink = Utils.normalise_bitlink(bitlink: bitlink)
           response = client.request(
             path: "/bitlinks/#{bitlink}/clicks/summary",
             params: {

data/lib/bitly/api/bitlink/link_click.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 require "time"
 require_relative "../base"
-require_relative '../list'
+require_relative "../list"
+require_relative "./utils"
 
 module Bitly
   module API
@@ -38,6 +39,7 @@ module Bitly
         #
         # @return [Bitly::API::Bitlink::LinkClick::List]
         def self.list(client:, bitlink:, unit: nil, units: nil, size: nil, unit_reference: nil)
+          bitlink = Utils.normalise_bitlink(bitlink: bitlink)
           response = client.request(
             path: "/bitlinks/#{bitlink}/clicks",
             params: {

data/lib/bitly/api/bitlink/utils.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Bitly
+  module API
+    class Bitlink
+      module Utils
+        def self.normalise_bitlink(bitlink:)
+          bitlink.gsub(/^https?:\/\//, "")
+        end
+      end
+    end
+  end
+end

data/lib/bitly/api/bitlink.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require_relative "./base"
 require_relative "./list"
+require_relative "./bitlink/utils"
 
 module Bitly
   module API
@@ -90,6 +91,7 @@ module Bitly
       #
       # @return [Bitly::API::Bitlink]
       def self.fetch(client:, bitlink:)
+        bitlink = Utils.normalise_bitlink(bitlink: bitlink)
         response = client.request(path: "/bitlinks/#{bitlink}")
         new(data: response.body, client: client, response: response)
       end
@@ -106,6 +108,7 @@ module Bitly
       #
       # @return [Bitly::API::Bitlink]
       def self.expand(client:, bitlink:)
+        bitlink = Utils.normalise_bitlink(bitlink: bitlink)
         response = client.request(path: "/expand", method: "POST", params: { "bitlink_id" => bitlink })
         new(data: response.body, client: client, response: response)
       end
@@ -241,6 +244,7 @@ module Bitly
 
       def initialize(data:, client:, response: nil, clicks: nil)
         assign_attributes(data)
+        @id = Utils.normalise_bitlink(bitlink: @id)
         if data["deeplinks"]
           @deeplinks = data["deeplinks"].map { |data| Deeplink.new(data: data) }
         else

data/lib/bitly/api/click_metric.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 require "time"
 require_relative "./base"
-require_relative './list'
+require_relative "./list"
+require_relative "./bitlink/utils"
 
 module Bitly
   module API
@@ -88,6 +89,7 @@ module Bitly
       end
 
       def self.list_referrers(client:, bitlink:, unit: nil, units: nil, size: nil, unit_reference: nil)
+        bitlink = Bitlink::Utils.normalise_bitlink(bitlink: bitlink)
         list_metrics(
           client: client,
           path: "/bitlinks/#{bitlink}/referrers",
@@ -99,6 +101,7 @@ module Bitly
       end
 
       def self.list_countries_by_bitlink(client:, bitlink:, unit: nil, units: nil, size: nil, unit_reference: nil)
+        bitlink = Bitlink::Utils.normalise_bitlink(bitlink: bitlink)
         list_metrics(
           client: client,
           path: "/bitlinks/#{bitlink}/countries",
@@ -110,6 +113,7 @@ module Bitly
       end
 
       def self.list_referring_domains(client:, bitlink:, unit: nil, units: nil, size: nil, unit_reference: nil)
+        bitlink = Bitlink::Utils.normalise_bitlink(bitlink: bitlink)
         list_metrics(
           client: client,
           path: "/bitlinks/#{bitlink}/referring_domains",
@@ -121,6 +125,7 @@ module Bitly
       end
 
       def self.list_referrers_by_domain(client:, bitlink:, unit: nil, units: nil, size: nil, unit_reference: nil)
+        bitlink = Bitlink::Utils.normalise_bitlink(bitlink: bitlink)
         response = client.request(
           path: "/bitlinks/#{bitlink}/referrers_by_domains",
           params: {

data/lib/bitly/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bitly
-  VERSION = "2.0.2"
+  VERSION = "2.1.0"
 end

data/sonar-project.properties

@@ -0,0 +1,6 @@
+sonar.organization=philnash
+sonar.projectKey=philnash_bitly
+
+sonar.sources=lib
+sonar.tests=spec
+sonar.ruby.coverage.reportPaths=coverage/coverage.json

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitly
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Phil Nash
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-18 00:00:00.000000000 Z
+date: 2022-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -78,14 +78,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: '0.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: simplecov_json_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -137,6 +151,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/FUNDING.yml"
+- ".github/workflows/sonarcloud.yml"
 - ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
@@ -156,6 +171,7 @@ files:
 - lib/bitly/api/bitlink/deeplink.rb
 - lib/bitly/api/bitlink/link_click.rb
 - lib/bitly/api/bitlink/paginated_list.rb
+- lib/bitly/api/bitlink/utils.rb
 - lib/bitly/api/bsd.rb
 - lib/bitly/api/click_metric.rb
 - lib/bitly/api/client.rb
@@ -175,6 +191,7 @@ files:
 - lib/bitly/http/response.rb
 - lib/bitly/oauth.rb
 - lib/bitly/version.rb
+- sonar-project.properties
 homepage: https://github.com/philnash/bitly
 licenses:
 - MIT