deeplink 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 591669474c391937e578ba03c7762a0699424ba7
-  data.tar.gz: ddb34acead4d79bf479fe392ae9a5a32e8cb5990
+  metadata.gz: 3e468ffce5a2691ac6e00b5b957d16c96aa72bd4
+  data.tar.gz: 876f5c92a4b2bf16b90d6be67c0cf55712499566
 SHA512:
-  metadata.gz: 7547e522241a24c91b939570490cbb41d4950a21c898b374d08e0093265c310a8093033feec8c68dc4e8b9aeab9d12bd3ae6a68496f8eb739f2bb97b7fa3f54e
-  data.tar.gz: ee81abdf9edfba560870cd314096a8a57c8f4267f7fbffdbee3c60c79a84609cfa172d4ab3addf33d0842e251a45014e58a9691673e2caa9eb7d95bd3b4477ef
+  metadata.gz: 7c80a0ef10ca309cca35442aa434abf16781e162e4f125925a451d2010daddfe53d706b6ceb0c54a6b236b18634b790381cfba2d3251587eed38431ec4fe7fc2
+  data.tar.gz: adac2c472a8f1cdbf4039655acf8059a2b61bdc7acb47cfeac915d40e7d1af9bc692350e8b011bb01a17714babb290f63af1792effbab44e1a88fe02f0bc6678

data/README.md

@@ -1,9 +1,5 @@
 # Deeplink
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/deeplink`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,7 +18,62 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Parsing a deep link
+
+Just call `Deeplink.parse` with a deep link String and then you can read the scheme and path.
+
+```ruby
+deeplink = Deeplink.parse('foursquare://checkins/12932')
+
+deeplink.scheme # => "foursquare"
+deeplink.path   # => "/checkins/12932"
+deeplink.to_s   # => "foursquare://checkins/12932"
+```
+
+### Query string
+
+To get the query parameters of a link use `query` method.
+
+```ruby
+deeplink = Deeplink.parse('foursquare://checkins/209823?test=true')
+
+deeplink.query # => { :test => "true" }
+```
+
+#### Adding a query parameter
+
+You can add one or more query parameters sending a Hash to `add_query`.
+
+```ruby
+deeplink = Deeplink.parse('foursquare://checkins/20982')
+
+deeplink.add_query(foo: 'bar') # => { :foo => "bar" }
+deeplink.to_s                  # => "foursquare://checkins/20982?foo=bar"
+
+deeplink = Deeplink.parse('foursquare://checkins/20982')
+
+deeplink.add_query(foo: 'bar', biz: 'baz') # => { :foo => "bar", :biz => "baz" }
+deeplink.to_s                              # => "foursquare://checkins/20982?foo=bar&biz=baz"
+```
+
+#### Removing a query parameter
+
+To remove query parameters call `remove_query` with the key (or list of keys) that you want to
+remove. The method will return the value of the deleted key(s).
+
+```ruby
+deeplink = Deeplink.parse('foursquare://checkins/20982?foo=bar')
+
+deeplink.remove_query(:foo) # => "bar"
+deeplink.to_s               # => "foursquare://checkins/20982"
+```
+
+```ruby
+deeplink = Deeplink.parse('foursquare://checkins/20982?foo=bar&fu=baz')
+
+deeplink.remove_query(:foo, :fu) # => ["bar", "baz"]
+deeplink.to_s                    # => "foursquare://checkins/20982"
+```
 
 ## Development
 
@@ -32,10 +83,9 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/deeplink.
+Bug reports and pull requests are welcome on GitHub at https://github.com/rikas/deeplink.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/deeplink/link.rb

@@ -3,34 +3,74 @@ require 'cgi'
 
 module Deeplink
   class Link
-    attr_accessor :scheme, :path, :query
+    attr_accessor :scheme, :path
+
+    # To add and remove items to the query string use #add_query and #remove_query
+    attr_reader :query
 
     def initialize(uri)
-      uri = parse(uri) unless uri.kind_of?(URI)
+      uri = parse(uri)
 
       self.scheme = uri.scheme
       self.path = uri.path
-      self.query = sanitize(parse_query(uri.query)) if uri.query
+
+      @query = sanitize(parse_query(uri.query)) if uri.query
     end
 
+    # Add query parameters to the link. You can add one or more parameters since this method
+    # receives a hash.
+    #
+    # === Example
+    #
+    #   deeplink = Deeplink.parse("link://directions")
+    #
+    #   deeplink.add_query(lat: 38.7179233, lon: -9.150129)
+    #
+    #   deeplink.to_s # => "link://directions?lat=38.7179233&lon=-9.150129"
     def add_query(hash)
-      self.query ||= {}
+      @query ||= {}
 
-      query.merge!(sanitize(hash))
+      @query.merge!(sanitize(hash))
     end
 
-    def remove_query(key)
+    # Removes query parameters by its keys. You can remove one or more parameters, sending a list of
+    # keys.
+    #
+    # === Example
+    #
+    #   deeplink = Deeplink.parse("link://directions?lat=38.7179233&lon=-9.150129&test=true")
+    #
+    #   deeplink.remove_query(:test) # => "true"
+    #
+    #   deeplink.remove_query(:lat, :lon) # => [38.7179233, -9.150129]
+    def remove_query(*keys)
       return unless query
 
-      query.delete(key.to_sym)
+      if keys.size > 1
+        keys.map { |key| query.delete(key.to_sym) }
+      else
+        query.delete(keys.first.to_sym)
+      end
     end
 
+    # Returns true if the link has a query string or false otherwise
+    #
+    # === Example
+    #
+    #   deeplink = Deeplink.parse("link://directions")
+    #
+    #   deeplink.has_query?             # => false
+    #
+    #   deeplink.add_query(foo: "bar")  # => { :foo => "bar" }
+    #
+    #   deeplink.has_query?             # => true
     def has_query?
       return false unless query
 
       !query.empty?
     end
 
+    # Returns the link as a String
     def to_s
       string = "#{scheme}:/#{path}"
 

data/lib/deeplink/version.rb

@@ -1,3 +1,3 @@
 module Deeplink
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deeplink
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ricardo Otero
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-12 00:00:00.000000000 Z
+date: 2015-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -118,3 +118,4 @@ signing_key:
 specification_version: 4
 summary: Gem to manage deep links parsing.
 test_files: []
+has_rdoc: