bitly 1.1.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: '087fb2a63ecc1d2528e91cc06d415921f30d5358'
-  data.tar.gz: 2b1d6c00ebc719756e84574bf054bd390027c4b5
+SHA256:
+  metadata.gz: 33a5d90e877bdac9ea6991afe188e198302be52327b36dd4ee7fc99970b23b2d
+  data.tar.gz: 46dd90271942653821d355f3c670237593f492f7d9a3c57562c2057189b332ff
 SHA512:
-  metadata.gz: 2c0c174a4c3e6249f35d1b5204639d4e0747a76702b01f0e8cda9c6d27f4e63abf533bfb5bf0afea80ac596455a4f890fe24c23d3d42dcf63dd1837ca4b2f960
-  data.tar.gz: 330100602a53d6b381c3383814450ccb1edc84d7006fa7520ade4a0bf55b8404da0d1ea2bf925e63bcbdd4ad7bb6ab0a94fdd29e721201cadaceda095570744b
+  metadata.gz: 8ddc083e1ad6b75fb88772688e70c8d9d65c221d6d8744f637ba05cd8b5b00fbf864847ba4b29d61e2f904e1315d0f3086b0f6e3338fc3d6d20ef5e13c769bc1
+  data.tar.gz: 249edc58187a0c701e8fbc337e80aaa89361b3115816394b48e22a194070a7f472a382ebbabc1bcb964cffac9abd4300b4e2b006b8cf7ed14a505f0ac634301e

data/.gitignore

@@ -1,3 +1,36 @@
-pkg
-doc
-Gemfile.lock
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Don't check in credentials
+config/env.yml
+]
+
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -1,11 +1,15 @@
 language: ruby
 sudo: required
 dist: trusty
+before_install:
+  - gem update --system
+  - gem install bundler
 rvm:
+  - 2.7
+  - 2.6
+  - 2.5
   - 2.4
   - 2.3
-  - 2.2
-  - 2.1
   - ruby-head
   - jruby-19mode
   - jruby-head

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 philnash@gmail.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

@@ -1,3 +1,6 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gemspec
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in bitly.gemspec
+gemspec

data/History.txt

@@ -1,7 +1,38 @@
 === Ongoing
 
-* updates
+...
 
+=== 2.0.1 / 2020-06-18
+
+* Fixes sending parameters in ClicksSummary (thanks @CodingFu)
+
+=== 2.0.0 / 2020-03-12
+
+* Complete overhaul of the gem
+* Supports version 4 of the Bitly API
+* See the README and documentation for more details
+
+=== 2.0.0.beta.2 / 2020-03-02
+
+* Uses autoload to improve memory consumption
+
+=== 2.0.0.beta.1 / 2020-02-15
+
+* Complete overhaul of the gem
+* Supports version 4 of the Bitly API
+
+=== 1.1.2
+
+* 2 minor updates
+
+  * Fix for obtaining clicks for branded subdomains
+  * Some fixes for Ruby compiler warnings
+
+=== 1.1.1
+
+* 3 minor updates
+
+  * Updates shoulda/activesupport versions in dev dependencies
   * Removes development dependency on Echoe and tidies up gemspec
   * Adds license to gemspec
 

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2016 Phil Nash
+Copyright (c) 2018 Phil Nash
 
 ### MIT License
 

data/README.md

@@ -1,93 +1,186 @@
-# bitly
+# Bitly
+
+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://travis-ci.org/philnash/bitly.svg?branch=master)](https://travis-ci.org/philnash/bitly) [![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)
+
+* [Installation](#installation)
+* [Usage](#usage)
+  * [Authentication](#authentication)
+  * [Creating an API client](#creating-an-api-client)
+  * [Shorten a link](#shorten-a-link)
+  * [Expand a link](#expand-a-link)
+* [Available API Endpoints](#available-api-endpoints)
+  * [Groups](#groups)
+  * [Organizations](#organizations)
+  * [Users](#users)
+  * [Bitlinks](#bitlinks)
+  * [Custom Bitlinks](#custom-bitlinks)
+  * [Campaigns](#campaigns)
+  * [BSDs (Branded Short Domains)](#bsds-branded-short-domains)
+  * [OAuth Apps](#oauth-apps)
+* [Development](#development)
+* [Contributing](#contributing)
+* [License](#license)
+* [Code of Conduct](#code-of-conduct)
+
+## Installation
+
+Add this line to your application's Gemfile:
 
-## DESCRIPTION:
+```ruby
+gem 'bitly'
+```
 
-A Ruby API for [http://bitly.com](http://bitly.com)
+And then execute:
 
-[http://dev.bitly.com](http://dev.bitly.com)
+```bash
+$ bundle install
+```
 
-[![Build Status](https://travis-ci.org/philnash/bitly.svg?branch=master)](https://travis-ci.org/philnash/bitly)
+Or install it yourself as:
 
-## NOTE:
+```bash
+$ gem install bitly
+```
 
-Bitly recently released their version 3 API. From this 0.5.0 release, the gem will continue to work the same but also provide a V3 module, using the version 3 API. The standard module will become deprecated, as Bitly do not plan to keep the version 2 API around forever.
+## Usage
 
-To move to using the version 3 API, call:
+### Authentication
 
-```ruby
-Bitly.use_api_version_3
-```
+All API endpoints require authentication with an OAuth token. You can get your own OAuth token from the [Bitly console](https://app.bitly.com/). Click on the account drop down menu, then _Profile Settings_ then _Generic Access Token_. Fill in your password and you can generate an OAuth access token.
 
-Then, when you call ``Bitly.new(username, api_key)`` you will get a ``Bitly::V3::Client`` instead, which provides the version 3 api calls (``shorten``, ``expand``, ``clicks``, ``validate`` and ``bitly_pro_domain``). See [http://dev.bitly.com](http://dev.bitly.com) for details.
+For other methods to generate access tokens for users via OAuth flows, see the [Authentication documentation](docs/authentication.md).
 
-Eventually, this will become the default version used and finally, the V3 module will disappear, with the version 3 classes replacing the version 2 classes.
+Once you have an access token you can use all the API methods.
 
-(Please excuse the lack of tests for the v3 classes, they are fully tested and ready to replace this whole codebase in the v3 branch of the GitHub repo, until I realized it would break everything.)
+### Creating an API client
 
-## INSTALLATION:
+All API methods are available through the `Bitly::API::Client`. Initialise the client with the access token like so:
 
-    gem install bitly
+```ruby
+client = Bitly::API::Client.new(token: token)
+```
 
-## USAGE:
+You can then use the client to perform actions with the API
 
-### Version 2 API
+### Shorten a link
 
-Create a Bitly client using your username and api key as follows:
+With an authenticated client you can shorten a link like so:
 
 ```ruby
-bitly = Bitly.new(username, api_key)
+bitlink = client.shorten(long_url: "http://example.com")
+bitlink.link
+# => http://bit.ly/2OUJim0
 ```
 
-You can then use that client to shorten or expand urls or return more information or statistics as so:
+### Expand a link
+
+With an authorised you can expand any Bitlink.
 
 ```ruby
-bitly.shorten('http://www.google.com')
-bitly.shorten('http://www.google.com', :history => 1) # adds the url to the api user's history
-bitly.expand('wQaT')
-bitly.info('http://bit.ly/wQaT')
-bitly.stats('http://bit.ly/wQaT')
+bitlink = client.expand(bitlink: "bit.ly/2OUJim0")
+bitlink.long_url
+# => http://example.com
 ```
 
-Each can be used in all the methods described in the API docs, the shorten function, for example, takes a url or an array of urls.
+## Available API Endpoints
 
-All four functions return a ``Bitly::Url`` object (or an array of ``Bitly::Url`` objects if you supplied an array as the input). You can then get all the information required from that object.
+This gem supports the following active v4 API endpoints for the[Bitly API](https://dev.bitly.com/v4_documentation.html).
 
-```ruby
-u = bitly.shorten('http://www.google.com') #=> Bitly::Url
-
-u.long_url #=> "http://www.google.com"
-u.short_url #=> "http://bit.ly/Ywd1"
-u.bitly_url #=> "http://bit.ly/Ywd1"
-u.jmp_url #=> "http://j.mp/Ywd1"
-u.user_hash #=> "Ywd1"
-u.hash #=> "2V6CFi"
-u.info #=> a ruby hash of the JSON returned from the API
-u.stats #=> a ruby hash of the JSON returned from the API
-
-bitly.shorten('http://www.google.com', 'keyword')
-```
+### Groups
 
-### Version 3 API
+[Groups documentation](docs/groups.md)
 
-Please see the Bit.ly API documentation [http://api.bit.ly](http://api.bit.ly) for details on the V3 API.
+- [x] [Retrieve groups (`GET /v4/groups`)](https://dev.bitly.com/v4/#operation/getGroups)
+- [x] [Retrieve group (`GET /v4/groups/{group_guid}`)](https://dev.bitly.com/v4/#operation/getGroup)
+- [x] [Update group (`PATCH /v4/groups/{group_guid}`)](https://dev.bitly.com/v4/#operation/updateGroup)
+- [x] [Delete group (`DELETE /v4/groups/{group_guid}`)](https://dev.bitly.com/v4/#operation/deleteGroup)
+- [x] [Retrieve tags by group (`GET /v4/groups/{group_guid}/tags`)](https://dev.bitly.com/v4/#operation/getGroupTags)
+- [x] [Retrieve group preferences (`GET /v4/groups/{group_guid}/preferences`)](https://dev.bitly.com/v4/#operation/getGroupPreferences)
+- [x] [Update group preferences (`PATCH /v4/groups/{group_guid}/preferences`)](https://dev.bitly.com/v4/#operation/updateGroupPreferences)
+- [x] [Retrieve Bitlinks by group (`GET /v4/groups/{group_guid}/bitlinks`)](https://dev.bitly.com/v4/#operation/getBitlinksByGroup)
+- [x] [Retrieve sorted Bitlinks by group (`GET /v4/groups/{group_guid}/bitlinks/{sort}`)](https://dev.bitly.com/v4/#operation/getSortedBitlinks)
+- [x] [Retrieve group shorten counts (`GET /v4/groups/{group_guid}/shorten_counts`)](https://dev.bitly.com/v4/#operation/getGroupShortenCounts)
+- [x] [Retrieve click metrics for a group by referring networks (`GET /v4/groups/{group_guid}/referring_networks`)](https://dev.bitly.com/v4/#operation/GetGroupMetricsByReferringNetworks)
+- [x] [Retrieve click metrics for a group by countries (`GET /v4/groups/{group_guid}/countries`)](https://dev.bitly.com/v4/#operation/getGroupMetricsByCountries)
 
-Get your access token here: [https://bitly.com/a/oauth_apps](https://bitly.com/a/oauth_apps).
+### Organizations
 
-### Configure bitly through initializer
+[Organizations documentation](docs/organizations.md)
 
-If you want to configure bitly through an initializer (e.g. `config/initializers/bitly.rb`), do the following:
+- [x] [Retrieve organizations (`GET /v4/organizations`)](https://dev.bitly.com/v4/#operation/getOrganizations)
+- [x] [Retrieve organization (`GET /v4/organizations/{organization_guid}`)](https://dev.bitly.com/v4/#operation/getOrganization)
+- [x] [Retrieve organization shorten counts (`GET /v4/organizations/{organization_guid}/shorten_counts`)](https://dev.bitly.com/v4/#operation/getOrganizationShortenCounts)
 
-```ruby
-Bitly.use_api_version_3
+### Users
 
-Bitly.configure do |config|
-  config.api_version = 3
-  config.access_token = "API_KEY"
-end
-```
+[Users documentation](docs/users.md)
 
-Instead of using `Bitly.new(username, api_key)` to get the client, use `Bitly.client`:
+- [x] [Retrieve user (`GET /v4/user`)](https://dev.bitly.com/v4/#operation/getUser)
+- [x] [Update user (`PATCH /v4/user`)](https://dev.bitly.com/v4/#operation/updateUser)
 
-```ruby
-Bitly.client.shorten('http://www.google.com')
-```
+### Bitlinks
+
+[Bitlinks documentation](docs/bitlinks.md)
+
+- [x] [Shorten a link (`POST /v4/shorten`)](https://dev.bitly.com/v4/#operation/createBitlink)
+- [x] [Expand a Bitlink (`POST /v4/expand`)](https://dev.bitly.com/v4/#operation/expandBitlink)
+- [x] [Retrieve a Bitlink (`GET /v4/bitlink/{bitlink}`)](https://dev.bitly.com/v4/#operation/getBitlink)
+- [x] [Create a Bitlink (`POST /v4/bitlinks`)](https://dev.bitly.com/v4/#operation/createFullBitlink)
+- [x] [Update a Bitlink (`PATCH /v4/bitlink/{bitlink}`)](https://dev.bitly.com/v4/#operation/updateBitlink)
+- [x] [Get clicks for a Bitlink (`GET /v4/bitlink/{bitlink}/clicks`)](https://dev.bitly.com/v4/#operation/getClicksForBitlink)
+- [x] [Get clicks summary for a Bitlink (`GET /v4/bitlink/{bitlink}/clicks/summary`)](https://dev.bitly.com/v4/#operation/getClicksSummaryForBitlink)
+- [x] [Get metrics for a Bitlink by countries (`GET /v4/bitlinks/{bitlink}/countries`)](https://dev.bitly.com/v4/#operation/getMetricsForBitlinkByCountries)
+- [x] [Get metrics for a Bitlink by referrers (`GET /v4/bitlinks/{bitlink}/referrers`)](https://dev.bitly.com/v4/#operation/getMetricsForBitlinkByReferrers)
+- [x] [Get metrics for a Bitlink by referring domains (`GET /v4/bitlinks/{bitlink}/referring_domains`)](https://dev.bitly.com/v4/#operation/getMetricsForBitlinkByReferringDomains)
+- [x] [Get metrics for a Bitlink by referrers by domain (`GET /v4/bitlinks/{bitlink}/referrers_by_domains`)](https://dev.bitly.com/v4/#operation/getMetricsForBitlinkByReferrersByDomains)
+- [ ] __[premium]__ [Get a QR code for a Bitlink (`GET /v4/{bitlink}/qr`)](https://dev.bitly.com/v4/#operation/getBitlinkQRCode)
+
+### Custom Bitlinks
+
+- [ ] [Add custom Bitlink (`POST /v4/custom_bitlinks`)](https://dev.bitly.com/v4/#operation/addCustomBitlink)
+- [ ] __[premium]__ [Retrieve custom Bitlink (`GET /v4/custom_bitlinks/{custom_bitlink}`)](https://dev.bitly.com/v4/#operation/getCustomBitlink)
+- [ ] __[premium]__ [Update custom Bitlink (`PATCH /v4/custom_bitlink/{custom_bitlink}`)](https://dev.bitly.com/v4/#operation/updateCustomBitlink)
+- [ ] __[premium]__ [Get metrics for a custom Bitlink by destination (`GET /v4/custom_bitlinks/{custom_bitlink}/clicks_by_destination`)](https://dev.bitly.com/v4/#operation/getCustomBitlinkMetricsByDestination)
+
+### Campaigns
+
+- [ ] __[premium]__ [Retrieve campaigns (`GET /v4/campaigns`)](https://dev.bitly.com/v4/#operation/getCampaigns)
+- [ ] __[premium]__ [Create campaign (`POST /v4/campaigns`)](https://dev.bitly.com/v4/#operation/createCampaign)
+- [ ] __[premium]__ [Retrieve campaign (`GET /v4/campaigns/{campaign_guid}`)](https://dev.bitly.com/v4/#operation/getCampaign)
+- [ ] __[premium]__ [Update campaign (`PATCH /v4/campaigns/{campaign_guid}`)](https://dev.bitly.com/v4/#operation/updateCampaign)
+- [ ] __[premium]__ [Retrieve channels (`GET /v4/channels`)](https://dev.bitly.com/v4/#operation/getChannels)
+- [ ] __[premium]__ [Create channel (`POST /v4/channels`)](https://dev.bitly.com/v4/#operation/createChannel)
+- [ ] __[premium]__ [Retrieve channel (`GET /v4/channels/{channel_guid}`)](https://dev.bitly.com/v4/#operation/getChannel)
+- [ ] __[premium]__ [Update channel (`PATCH /v4/channels/{channel_guid}`)](https://dev.bitly.com/v4/#operation/updateChannel)
+
+### BSDs (Branded Short Domains)
+
+[Branded Short Domains documentation](docs/branded_short_domains.md)
+
+- [x] [Retrieve BSDs (`GET /v4/bsds`)](https://dev.bitly.com/v4/#operation/getBSDs)
+
+### OAuth Apps
+
+[OAuth Apps documentation](docs/oauth_apps.md)
+
+- [x] [Retrieve OAuth App (`GET /v4/apps/{client_id}`)](https://dev.bitly.com/v4/#operation/getOAuthApp)
+
+## 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/philnash/bitly. 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 Bitly project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/philnash/bitly/blob/master/CODE_OF_CONDUCT.md).