branch_io 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 52055a70b4c8c8037f42010e08bfc77c6978c68f
-  data.tar.gz: 9ae189b23d59056108a8ace997ea8f8e37e07697
+SHA256:
+  metadata.gz: 7a81bf76ea664bdcf8b02806cef5e906cc48b21f70a4bc758e44e154939f50fd
+  data.tar.gz: d92062aa427f81d7dcbe03bc0ad28a833da800a46670f945f1e5e0f28d3cc5e8
 SHA512:
-  metadata.gz: 1e09d7d9674a92e6e8f73b5af47e8eedf594982f0b88923e1dc3385bef16c874ed4a590a78ca33e30ec65a797fc7a3cf9e78c4c210dfe27edd098c496ca8bf18
-  data.tar.gz: 4db7f87336d7b7495066f467cb723b08be1f581367728e235b01f70f23dc4ec8fee922cdd8b2ce13c753d6479706354a529f067621541223677f7ea85db31146
+  metadata.gz: 47546d905112a07cbcc2ff7fe2369357a0b6a0cd8405fcd460ba563a1efd1df372bf48c78ce026852b783e138d8cb2640104f3d33b67dd11ee2c7ea7c6c13d65
+  data.tar.gz: bc51dd049d60a0b80ad9ca86653e23296027a984dd25cc11870ccb5814efab0dc2b9141c4f505ebc9185d49bb4fabfb4309e20019a2181a544d37bcc64b7166b

data/.circleci/config.yml

@@ -0,0 +1,45 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.4.2
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./venv
+          key: v1-dependencies-{{ checksum "Gemfile" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            bundle exec rake
+
+      # collect reports
+      - store_test_results:
+          path: ~/repo/test-results
+      - store_artifacts:
+          path: ~/repo/test-results
+          destination: test-results

data/.gitignore

@@ -10,3 +10,4 @@
 .idea/
 .DS_Store
 .idea/
+test-results

data/.rspec

@@ -1,3 +1,5 @@
 --require spec_helper
 --format documentation
 --color
+--format RspecJunitFormatter
+--out test-results/rspec/rspec.xml

data/README.md

@@ -1,7 +1,15 @@
 # A Ruby wrapper for the [branch.io](http://branch.io) [public API](https://github.com/BranchMetrics/branch-deep-linking-public-api)
 
+[![Gem](https://img.shields.io/gem/v/branch_io.svg?style=flat)](https://rubygems.org/gems/branch_io)
+[![Downloads](https://img.shields.io/gem/dt/branch_io.svg?style=flat)](https://rubygems.org/gems/branch_io)
+[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/ushu/branch_io/blob/master/LICENSE)
+<!-- [![CircleCI](https://img.shields.io/circleci/project/github/ushu/branch_io.svg)](https://circleci.com/gh/ushu/branch_io) -->
+
+Please see the [Branch documentation](https://docs.branch.io) for general information. Please report any
+problems by opening issues in this repo.
+
 This is a simple [HTTparty](https://github.com/jnunemaker/httparty)-based gem for accessing the branch.io REST APIs,
-as descried [here](https://github.com/BranchMetrics/branch-deep-linking-public-api).
+as described [here](https://github.com/BranchMetrics/branch-deep-linking-public-api). See the [Branch API documentation](https://docs.branch.io/pages/apps/api/) for further details.
 
 It follows the exact design of the original REST API: basically links are resources you can generate and update,
 provided you hold the required credentials.
@@ -130,7 +138,7 @@ end
 _The only difference between `#links` and `#links!` is that the latter version will
 raise a new `BranchIO::ErrorApiCallFailed` exception in case of an error._
 
-### `Client#link_info` and `Client#link_info!`: Registers a [new deep linking URL](https://github.com/BranchMetrics/branch-deep-linking-public-api#creating-a-deep-linking-url)
+### `Client#link_info` and `Client#link_info!`: Returns information about a [deep linking URL](https://github.com/BranchMetrics/branch-deep-linking-public-api#creating-a-deep-linking-url)
 
 **BEWARE: this method requires the BRANCH_SECRET to be defined**
 
@@ -151,7 +159,7 @@ end
 **The only difference between `#link_info` and `#link_info!` is that the latter version will
 raise a new `BranchIO::ErrorApiCallFailed` exception in case of an error.**
 
-### `Client#update_link` and `Client#update_link!`: Registers a [new deep linking URL](https://github.com/BranchMetrics/branch-deep-linking-public-api#creating-a-deep-linking-url)
+### `Client#update_link` and `Client#update_link!`: Updates a [deep linking URL](https://github.com/BranchMetrics/branch-deep-linking-public-api#creating-a-deep-linking-url)
 
 **BEWARE: this method requires the BRANCH_SECRET to be defined**
 
@@ -173,6 +181,27 @@ end
 **The only difference between `#update_link` and `#update_link!` is that the latter version will
 raise a new `BranchIO::ErrorApiCallFailed` exception in case of an error.**
 
+### `Client#delete_link` and `Client#delete_link!`: Deletes a [deep linking URL](https://github.com/BranchMetrics/branch-deep-linking-public-api#creating-a-deep-linking-url)
+
+**BEWARE: this method requires the BRANCH_SECRET to be defined**
+
+This method deletes an existing link and returns the URL and deletion confirmation.
+
+```ruby
+# Call the service
+res = client.delete_link("https://...")
+
+# Inspect the server response
+if res.success?
+  puts "Successfully deleted link: #{res.link_deleted.to_json['url']}"
+else
+  puts "Error updating link info: #{res.error}"
+end
+```
+
+**The only difference between `#delete_link` and `#delete_link!` is that the latter version will
+raise a new `BranchIO::ErrorApiCallFailed` exception in case of an error.**
+
 ## 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.
@@ -194,4 +223,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/ushu/b
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/branch_io/client.rb

@@ -40,6 +40,11 @@ module BranchIO
       self.class.put(url, body: body, headers: default_headers)
     end
 
+    def delete(url, data = {})
+      body = data.to_json
+      self.class.delete(url, body: body, headers: default_headers)
+    end
+
     private
 
     def ensure_branch_secret_defined!

data/lib/branch_io/client/links.rb

@@ -115,6 +115,36 @@ module BranchIO
           ErrorResponse.new(raw_response)
         end
       end
+
+      def delete_link!(url)
+        res = delete_link(url)
+        res.validate!
+        res
+      end
+
+      def delete_link(url)
+        ensure_branch_secret_defined!
+
+        # Build the request URL
+        encoded_url = URI.encode_www_form_component(url)
+        delete_url = "#{LINK_PATH}?url=#{encoded_url}"
+
+        # Build the request body
+        delete_json = {
+          branch_key: self.branch_key,
+          branch_secret: self.branch_secret
+        }
+
+        # Call branch.io public API
+        raw_response = self.delete(delete_url, delete_json)
+
+        # Wrap the result in a Response
+        if raw_response.success?
+          LinkDeletedResponse.new(raw_response)
+        else
+          ErrorResponse.new(raw_response)
+        end
+      end
     end
   end
 end

data/lib/branch_io/client/response.rb

@@ -107,5 +107,15 @@ module BranchIO
         @link_properties ||= BranchIO::LinkProperties.new(json)
       end
     end
+
+    class LinkDeletedResponse < Response
+      def success?
+        json["deleted"] == true
+      end
+
+      def url
+        json["url"]
+      end
+    end
   end
 end

data/lib/branch_io/version.rb

@@ -1,3 +1,3 @@
 module BranchIO
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: branch_io
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Aurélien Noce
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-17 00:00:00.000000000 Z
+date: 2020-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -158,11 +158,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -196,8 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: A Client for the Branch.io deep linking public API

data/.travis.yml

@@ -1,3 +0,0 @@
-language: ruby
-rvm:
-  - 2.4.2