branch_io 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b07bcbbfa55600f273c4257643bc424463df98d
-  data.tar.gz: f5debc608b842ac322063a2b48be2731740164b4
+  metadata.gz: 52055a70b4c8c8037f42010e08bfc77c6978c68f
+  data.tar.gz: 9ae189b23d59056108a8ace997ea8f8e37e07697
 SHA512:
-  metadata.gz: 4e3e8282deede639c610ba9611ff7853d4f5694d3bbfcde76ca462bdd27e1c075325187e67ff24199afaa9c58b1737c6d6c9461b6aa913029eb8b710eddf9a49
-  data.tar.gz: 97c9fa7a59d7e2be3f3088a80fa6d8137b1d94ee0852449a397b5aff7ded14f53af00c990fea436943edace7980cab09307371fb82b8fcf271cd3f9de4ccf6b9
+  metadata.gz: 1e09d7d9674a92e6e8f73b5af47e8eedf594982f0b88923e1dc3385bef16c874ed4a590a78ca33e30ec65a797fc7a3cf9e78c4c210dfe27edd098c496ca8bf18
+  data.tar.gz: 4db7f87336d7b7495066f467cb723b08be1f581367728e235b01f70f23dc4ec8fee922cdd8b2ce13c753d6479706354a529f067621541223677f7ea85db31146

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,242 @@
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+Style/MultipleComparison:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+# kind_of? is a good way to check a type
+Style/ClassCheck:
+  EnforcedStyle: kind_of?
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# This doesn't work with older versions of Ruby (pre 2.4.0)
+Style/SafeNavigation:
+  Enabled: false
+
+# This doesn't work with older versions of Ruby (pre 2.4.0)
+Performance/RegexpMatch:
+  Enabled: false
+
+# This suggests use of `tr` instead of `gsub`. While this might be more performant,
+# these methods are not at all interchangable, and behave very differently. This can
+# lead to people making the substitution without considering the differences.
+Performance/StringReplacement:
+  Enabled: false
+
+# .length == 0 is also good, we don't always want .zero?
+Style/NumericPredicate:
+  Enabled: false
+
+# this would cause errors with long lanes
+Metrics/BlockLength:
+  Enabled: false
+
+# this is a bit buggy
+Metrics/ModuleLength:
+  Enabled: false
+
+# certificate_1 is an okay variable name
+Naming/VariableNumber:
+  Enabled: false
+
+# This is used a lot across the fastlane code base for config files
+Style/MethodMissing:
+  Enabled: false
+
+#
+#   File.chmod(0777, f)
+#
+# is easier to read than
+#
+#   File.chmod(0o777, f)
+#
+Style/NumericLiteralPrefix:
+  Enabled: false
+
+#
+# command = (!clean_expired.nil? || !clean_pattern.nil?) ? CLEANUP : LIST
+#
+# is easier to read than
+#
+# command = !clean_expired.nil? || !clean_pattern.nil? ? CLEANUP : LIST
+#
+Style/TernaryParentheses:
+  Enabled: false
+
+# sometimes it is useful to have those empty methods
+Style/EmptyMethod:
+  Enabled: false
+
+# It's better to be more explicit about the type
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+# specs sometimes have useless assignments, which is fine
+Lint/UselessAssignment:
+  Exclude:
+    - '**/spec/**/*'
+
+# We could potentially enable the 2 below:
+Layout/IndentHash:
+  Enabled: false
+
+Layout/AlignHash:
+  Enabled: false
+
+# HoundCI doesn't like this rule
+Layout/DotPosition:
+  Enabled: false
+
+# We allow !! as it's an easy way to convert ot boolean
+Style/DoubleNegation:
+  Enabled: false
+
+# Prevent to replace [] into %i
+Style/SymbolArray:
+  Enabled: false
+
+# We still support Ruby 2.0.0
+Layout/IndentHeredoc:
+  Enabled: false
+
+# This cop would not work fine with rspec
+Style/MixinGrouping:
+  Exclude:
+    - '**/spec/**/*'
+
+# Sometimes we allow a rescue block that doesn't contain code
+Lint/HandleExceptions:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+# Needed for $verbose
+Style/GlobalVars:
+  Enabled: false
+
+# We want to allow class Fastlane::Class
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# $? Exit
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+# The %w might be confusing for new users
+Style/WordArray:
+  MinSize: 19
+
+# raise and fail are both okay
+Style/SignalException:
+  Enabled: false
+
+# Better too much 'return' than one missing
+Style/RedundantReturn:
+  Enabled: false
+
+# Having if in the same line might not always be good
+Style/IfUnlessModifier:
+  Enabled: false
+
+# and and or is okay
+Style/AndOr:
+  Enabled: false
+
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 320
+
+
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 370
+
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 17
+
+Metrics/PerceivedComplexity:
+  Max: 18
+
+# Sometimes it's easier to read without guards
+Style/GuardClause:
+  Enabled: false
+
+# We allow both " and '
+Style/StringLiterals:
+  Enabled: false
+
+# something = if something_else
+# that's confusing
+Style/ConditionalAssignment:
+  Enabled: false
+
+# Better to have too much self than missing a self
+Style/RedundantSelf:
+  Enabled: false
+
+# e.g.
+# def self.is_supported?(platform)
+# we may never use `platform`
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+# the let(:key) { ... }
+Lint/ParenthesesAsGroupedExpression:
+  Exclude:
+    - '**/spec/**/*'
+
+# This would reject is_ in front of methods
+# We use `is_supported?` everywhere already
+Naming/PredicateName:
+  Enabled: false
+
+# We allow the $
+Style/PerlBackrefs:
+  Enabled: false
+
+# They have not to be snake_case
+Naming/FileName:
+  Exclude:
+    - '**/Gemfile'
+    - '**/Rakefile'
+    - '**/*.gemspec'
+
+# We're not there yet
+Style/Documentation:
+  Enabled: false
+
+# Added after upgrade to 0.38.0
+Style/MutableConstant:
+  Enabled: false
+
+# length > 0 is good
+Style/ZeroLengthPredicate:
+  Enabled: false
+
+# Adds complexity
+Style/IfInsideElse:
+  Enabled: false
+
+# Sometimes we just want to 'collect'
+Style/CollectionMethods:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+2.4.2

data/.travis.yml

@@ -1,4 +1,3 @@
 language: ruby
 rvm:
-  - 2.0.0
-before_install: gem install bundler -v 1.11.2
+  - 2.4.2

data/Rakefile

@@ -1,6 +1,9 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
 
-RSpec::Core::RakeTask.new(:spec)
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
 
-task :default => :spec
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+task default: [:spec, :rubocop]

data/branch_io.gemspec

@@ -1,4 +1,4 @@
-# coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'branch_io/version'
@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Aurélien Noce"]
   spec.email         = ["aurelien.noce@imagine-app.fr"]
 
-  spec.summary       = %q{A Client for the Branch.io deep linking public API}
-  spec.description   = %q{This wrapper allows you to create and update deep links on branch.io, using the public REST API.}
+  spec.summary       = 'A Client for the Branch.io deep linking public API'
+  spec.description   = 'This wrapper allows you to create and update deep links on branch.io, using the public REST API.'
   spec.homepage      = "https://github.com/ushu/branch_io"
   spec.license       = "MIT"
 
@@ -22,7 +22,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency "httparty", "~> 0.13"
   spec.add_development_dependency "vcr", "~> 3.0"
   spec.add_development_dependency "webmock", "~> 2.1"
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec_junit_formatter"
+  spec.add_development_dependency "rspec-simplecov"
+  spec.add_development_dependency "rubocop", "~> 0.50.0"
+  spec.add_development_dependency "simplecov"
 end

data/lib/branch_io.rb

@@ -1,10 +1,8 @@
 require "branch_io/version"
+require "branch_io/client"
+require "branch_io/link_properties"
 
 module BranchIO
-
-  autoload :Client, "branch_io/client"
-  autoload :LinkProperties, "branch_io/link_properties"
-
   # Default client helper methods: delegate unknown calls to a new Client instance w/ default constructor params
 
   def self.method_missing(name, *args, &block)
@@ -23,5 +21,4 @@ module BranchIO
     end
     super
   end
-
 end

data/lib/branch_io/client.rb

@@ -5,7 +5,6 @@ require "json"
 require_relative "client/links"
 
 module BranchIO
-
   class Client
     class ErrorMissingBranchKey < StandardError; end
 
@@ -18,12 +17,12 @@ module BranchIO
 
     # Basic Api client
     attr_reader :branch_key, :branch_secret
-    def initialize(branch_key=ENV["BRANCH_KEY"], branch_secret=ENV["BRANCH_SECRET"])
+    def initialize(branch_key = ENV["BRANCH_KEY"], branch_secret = ENV["BRANCH_SECRET"])
       @branch_key = branch_key
       @branch_secret = branch_secret
 
       unless branch_key
-        raise ErrorMissingBranchKey.new("No Branch Key found: please provided one such key to BranchIO::Client#initialize or by setting the BRANCH_KEY environment variable")
+        raise ErrorMissingBranchKey, "No Branch Key found: please provided one such key to BranchIO::Client#initialize or by setting the BRANCH_KEY environment variable"
       end
     end
 
@@ -31,12 +30,12 @@ module BranchIO
       self.class.get(url, headers: default_headers)
     end
 
-    def post(url, data={})
+    def post(url, data = {})
       body = data.to_json
       self.class.post(url, body: body, headers: default_headers)
     end
 
-    def put(url, data={})
+    def put(url, data = {})
       body = data.to_json
       self.class.put(url, body: body, headers: default_headers)
     end
@@ -45,7 +44,7 @@ module BranchIO
 
     def ensure_branch_secret_defined!
       unless branch_secret
-        raise ErrorMissingBranchKey.new("No Branch Secret found: please provided one such key to BranchIO::Client#initialize or by setting the BRANCH_SECRET environment variable")
+        raise ErrorMissingBranchKey, "No Branch Secret found: please provided one such key to BranchIO::Client#initialize or by setting the BRANCH_SECRET environment variable"
       end
     end
 
@@ -55,7 +54,5 @@ module BranchIO
         "Accept" => "application/json"
       }
     end
-
   end
-
 end

data/lib/branch_io/client/links.rb

@@ -2,17 +2,16 @@ require_relative "response"
 
 module BranchIO
   class Client
-
     module Links
       LINK_PATH = "/v1/url"
 
-      def link!(options={})
+      def link!(options = {})
         res = link(options)
         res.validate!
         res
       end
 
-      def link(options={})
+      def link(options = {})
         # Load and check the link properties
         link_properties = BranchIO::LinkProperties.wrap(options)
 
@@ -34,15 +33,15 @@ module BranchIO
         end
       end
 
-      def links!(options={})
+      def links!(options = {})
         res = links(options)
         res.validate!
         res
       end
 
-      def links(options=[])
+      def links(options = [])
         # Load and check the links properties
-        link_properties_array = options.map{ |o| BranchIO::LinkProperties.wrap(o) }
+        link_properties_array = options.map { |o| BranchIO::LinkProperties.wrap(o) }
 
         # Build the request
         links_url = "#{LINK_PATH}/bulk/#{self.branch_key}"
@@ -59,13 +58,13 @@ module BranchIO
         end
       end
 
-      def update_link!(options={})
+      def update_link!(options = {})
         res = update_link(options)
         res.validate!
         res
       end
 
-      def update_link(url, options={})
+      def update_link(url, options = {})
         ensure_branch_secret_defined!
 
         # Load and check the links configuration properties
@@ -94,7 +93,7 @@ module BranchIO
         end
       end
 
-      def link_info!(options={})
+      def link_info!(options = {})
         res = link_info(options)
         res.validate!
         res
@@ -116,8 +115,6 @@ module BranchIO
           ErrorResponse.new(raw_response)
         end
       end
-
     end
-
   end
 end

data/lib/branch_io/client/response.rb

@@ -28,7 +28,7 @@ module BranchIO
       end
 
       def validate!
-        raise ErrorApiCallFailed.new(self) unless success?
+        raise ErrorApiCallFailed, self unless success?
       end
 
       def json
@@ -84,7 +84,7 @@ module BranchIO
       def responses
         @responses ||= json.map do |url_info|
           # below the EmbeddedResponseWrapper(s) act as a dummp HTTParty response
-          if url_info.has_key?("error")
+          if url_info.key?("error")
             ErrorResponse.new(EmbeddedResponseWrapper.new(url_info))
           else
             UrlResponse.new(EmbeddedResponseWrapper.new(url_info))
@@ -92,9 +92,14 @@ module BranchIO
         end
       end
 
+      # rubocop: disable Lint/UselessAccessModifier
+      # Not sure why RuboCop thinks this is useless.
+
       private
 
-      class EmbeddedResponseWrapper < Struct.new(:parsed_response); end
+      # rubocop: enable Lint/UselessAccessModifier
+
+      EmbeddedResponseWrapper = Struct.new(:parsed_response)
     end
 
     class LinkPropertiesResponse < Response
@@ -102,6 +107,5 @@ module BranchIO
         @link_properties ||= BranchIO::LinkProperties.new(json)
       end
     end
-
   end
 end

data/lib/branch_io/link_properties.rb

@@ -1,5 +1,4 @@
 module BranchIO
-
   class LinkProperties
     attr_reader :tags
     attr_reader :channel
@@ -18,8 +17,8 @@ module BranchIO
       end
     end
 
-    def initialize(options={})
-      @tags     = options.delete(:tags)     ||options.delete("tags")
+    def initialize(options = {})
+      @tags     = options.delete(:tags) || options.delete("tags")
       @channel  = options.delete(:channel)  || options.delete("channel")
       @feature  = options.delete(:feature)  || options.delete("feature")
       @campaign = options.delete(:campaign) || options.delete("campaign")
@@ -29,7 +28,7 @@ module BranchIO
       @data     = options.delete(:data)     || options.delete("data")
 
       unless options.empty?
-        raise ErrorInvalidParameters.new(options.keys)
+        raise ErrorInvalidParameters, options.keys
       end
     end
 
@@ -50,9 +49,8 @@ module BranchIO
       attr_reader :parameters
       def initialize(parameters)
         @parameters = parameters
-        super("Invalid parameters for BranchIO::LinkProperties: \"#{@parameters.join(", ")}\"")
+        super("Invalid parameters for BranchIO::LinkProperties: \"#{@parameters.join(', ')}\"")
       end
     end
   end
-
 end

data/lib/branch_io/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: branch_io
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Aurélien Noce
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-07 00:00:00.000000000 Z
+date: 2017-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -56,30 +56,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.50.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.50.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This wrapper allows you to create and update deep links on branch.io,
   using the public REST API.
 email:
@@ -104,6 +160,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
@@ -140,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: A Client for the Branch.io deep linking public API