bitly 0.6.1 → 0.6.2

data/History.txt

@@ -1,3 +1,15 @@
+=== 0.6.2 / 2011-11-10
+
+* 2 minor enhancements
+  
+  * Adds days parameter to clicks_by_minute v3 API call
+  * Converts Readme to markdown
+
+* 2 minor bug fixes
+
+  * Increases HTTParty version to avoid issues with Rubygems
+  * Stops mutating arguments on array methods
+
 === 0.6.1 / 2011-01-12
 
 * 1 minor enhancement

data/Manifest

@@ -1,6 +1,6 @@
 History.txt
 Manifest
-README.txt
+README.md
 Rakefile
 bitly.gemspec
 lib/bitly.rb

data/README.md

@@ -0,0 +1,87 @@
+# bitly
+
+## DESCRIPTION:
+
+A Ruby API for [http://bit.ly](http://bit.ly) (and now (http://j.mp)[http://j.mp])
+
+[http://code.google.com/p/bitly-api/wiki/ApiDocumentation](http://code.google.com/p/bitly-api/wiki/ApiDocumentation)
+
+## NOTE:
+
+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.
+
+To move to using the version 3 API, call:
+
+    Bitly.use_api_version_3
+
+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://api.bit.ly](http://api.bit.ly) for details.
+
+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.
+
+(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.)
+
+## INSTALLATION:
+
+    gem install bitly
+
+## USAGE:
+
+### Version 2 API
+
+Create a Bitly client using your username and api key as follows:
+
+    bitly = Bitly.new(username, api_key)
+
+You can then use that client to shorten or expand urls or return more information or statistics as so:
+
+    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')
+
+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.
+
+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.
+
+    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')
+
+### Version 3 API
+
+Please see the Bit.ly API documentation [http://api.bit.ly](http://api.bit.ly) for details on the V3 API.
+
+## LICENSE:
+
+> (The MIT License)
+>
+> Copyright (c) 2009 Phil Nash
+>
+> Permission is hereby granted, free of charge, to any person obtaining
+> a copy of this software and associated documentation files (the
+> 'Software'), to deal in the Software without restriction, including
+> without limitation the rights to use, copy, modify, merge, publish,
+> distribute, sublicense, and/or sell copies of the Software, and to
+> permit persons to whom the Software is furnished to do so, subject to
+> the following conditions:
+> 
+> The above copyright notice and this permission notice shall be
+> included in all copies or substantial portions of the Software.
+> 
+> THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+> IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+> CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+> TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+> SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -8,6 +8,6 @@ Echoe.new('bitly', Bitly::VERSION) do |p|
   p.url = "http://github.com/philnash/bitly"
   p.author = "Phil Nash"
   p.email = "philnash@gmail.com"
-  p.extra_deps      = [['crack', '>= 0.1.4'], ['httparty', '>= 0.5.2'], ['oauth2', '>= 0.1.1']]
+  p.extra_deps      = [['crack', '>= 0.1.4'], ['httparty', '>= 0.7.6'], ['oauth2', '>= 0.1.1']]
   p.development_dependencies = []
 end

data/bitly.gemspec

@@ -2,38 +2,39 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bitly}
-  s.version = "0.6.1"
+  s.version = "0.6.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Phil Nash"]
-  s.date = %q{2011-01-12}
+  s.date = %q{2011-11-10}
   s.description = %q{Use the bit.ly API to shorten or expand URLs}
   s.email = %q{philnash@gmail.com}
-  s.extra_rdoc_files = ["README.txt", "lib/bitly.rb", "lib/bitly/client.rb", "lib/bitly/url.rb", "lib/bitly/utils.rb", "lib/bitly/v3.rb", "lib/bitly/v3/bitly.rb", "lib/bitly/v3/client.rb", "lib/bitly/v3/country.rb", "lib/bitly/v3/day.rb", "lib/bitly/v3/missing_url.rb", "lib/bitly/v3/oauth.rb", "lib/bitly/v3/realtime_link.rb", "lib/bitly/v3/referrer.rb", "lib/bitly/v3/url.rb", "lib/bitly/v3/user.rb", "lib/bitly/version.rb"]
-  s.files = ["History.txt", "Manifest", "README.txt", "Rakefile", "bitly.gemspec", "lib/bitly.rb", "lib/bitly/client.rb", "lib/bitly/url.rb", "lib/bitly/utils.rb", "lib/bitly/v3.rb", "lib/bitly/v3/bitly.rb", "lib/bitly/v3/client.rb", "lib/bitly/v3/country.rb", "lib/bitly/v3/day.rb", "lib/bitly/v3/missing_url.rb", "lib/bitly/v3/oauth.rb", "lib/bitly/v3/realtime_link.rb", "lib/bitly/v3/referrer.rb", "lib/bitly/v3/url.rb", "lib/bitly/v3/user.rb", "lib/bitly/version.rb", "test/bitly/test_client.rb", "test/bitly/test_url.rb", "test/bitly/test_utils.rb", "test/fixtures/cnn.json", "test/fixtures/cnn_and_google.json", "test/fixtures/expand_cnn.json", "test/fixtures/expand_cnn_and_google.json", "test/fixtures/google_and_cnn_info.json", "test/fixtures/google_info.json", "test/fixtures/google_stats.json", "test/fixtures/shorten_error.json", "test/test_helper.rb"]
+  s.extra_rdoc_files = ["README.md", "lib/bitly.rb", "lib/bitly/client.rb", "lib/bitly/url.rb", "lib/bitly/utils.rb", "lib/bitly/v3.rb", "lib/bitly/v3/bitly.rb", "lib/bitly/v3/client.rb", "lib/bitly/v3/country.rb", "lib/bitly/v3/day.rb", "lib/bitly/v3/missing_url.rb", "lib/bitly/v3/oauth.rb", "lib/bitly/v3/realtime_link.rb", "lib/bitly/v3/referrer.rb", "lib/bitly/v3/url.rb", "lib/bitly/v3/user.rb", "lib/bitly/version.rb"]
+  s.files = ["History.txt", "Manifest", "README.md", "Rakefile", "bitly.gemspec", "lib/bitly.rb", "lib/bitly/client.rb", "lib/bitly/url.rb", "lib/bitly/utils.rb", "lib/bitly/v3.rb", "lib/bitly/v3/bitly.rb", "lib/bitly/v3/client.rb", "lib/bitly/v3/country.rb", "lib/bitly/v3/day.rb", "lib/bitly/v3/missing_url.rb", "lib/bitly/v3/oauth.rb", "lib/bitly/v3/realtime_link.rb", "lib/bitly/v3/referrer.rb", "lib/bitly/v3/url.rb", "lib/bitly/v3/user.rb", "lib/bitly/version.rb", "test/bitly/test_client.rb", "test/bitly/test_url.rb", "test/bitly/test_utils.rb", "test/fixtures/cnn.json", "test/fixtures/cnn_and_google.json", "test/fixtures/expand_cnn.json", "test/fixtures/expand_cnn_and_google.json", "test/fixtures/google_and_cnn_info.json", "test/fixtures/google_info.json", "test/fixtures/google_stats.json", "test/fixtures/shorten_error.json", "test/test_helper.rb"]
   s.homepage = %q{http://github.com/philnash/bitly}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Bitly", "--main", "README.txt"]
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Bitly", "--main", "README.md"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{bitly}
-  s.rubygems_version = %q{1.4.1}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Use the bit.ly API to shorten or expand URLs}
   s.test_files = ["test/bitly/test_client.rb", "test/bitly/test_url.rb", "test/bitly/test_utils.rb", "test/test_helper.rb"]
 
   if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<crack>, [">= 0.1.4"])
-      s.add_runtime_dependency(%q<httparty>, [">= 0.5.2"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0.7.6"])
       s.add_runtime_dependency(%q<oauth2>, [">= 0.1.1"])
     else
       s.add_dependency(%q<crack>, [">= 0.1.4"])
-      s.add_dependency(%q<httparty>, [">= 0.5.2"])
+      s.add_dependency(%q<httparty>, [">= 0.7.6"])
       s.add_dependency(%q<oauth2>, [">= 0.1.1"])
     end
   else
     s.add_dependency(%q<crack>, [">= 0.1.4"])
-    s.add_dependency(%q<httparty>, [">= 0.5.2"])
+    s.add_dependency(%q<httparty>, [">= 0.7.6"])
     s.add_dependency(%q<oauth2>, [">= 0.1.1"])
   end
 end

data/lib/bitly/v3/client.rb

@@ -63,7 +63,7 @@ module Bitly
       #
       # Returns the results in the order they were entered
       def lookup(input)
-        input = [input] if input.is_a?(String)
+        input = arrayize(input)
         query = input.inject([]) { |query, i| query << "url=#{CGI.escape(i)}" }
         query = "/lookup?" + query.join('&')
         response = get(query)
@@ -104,11 +104,20 @@ module Bitly
       end
 
       # Takes a short url, hash or array of either and gets the clicks by day
-      def clicks_by_day(input)
-        get_method(:clicks_by_day, input)
+      def clicks_by_day(input, opts={})
+        opts.reject! { |k, v| k.to_s != 'days' }
+        get_method(:clicks_by_day, input, opts)
       end
         
       private
+
+      def arrayize(arg)
+        if arg.is_a?(String)
+          [arg] 
+        else
+          arg.dup
+        end
+      end
     
       def get(method, opts={})
         opts[:query] ||= {}
@@ -137,8 +146,8 @@ module Bitly
         return Bitly::V3::Url.new(self,response['data'])
       end
     
-      def get_method(method, input)
-        input = [input] if input.is_a? String
+      def get_method(method, input, opts={})
+        input = arrayize(input)
         query = input.inject([]) do |query,i|
           if is_a_short_url?(i)
             query << "shortUrl=#{CGI.escape(i)}"
@@ -146,6 +155,9 @@ module Bitly
             query << "hash=#{CGI.escape(i)}"
           end
         end
+        query = opts.inject(query) do |query, (k,v)|
+          query << "#{k}=#{v}"
+        end
         query = "/#{method}?" + query.join('&')
         response = get(query)
         results = response['data'][method.to_s].inject([]) do |results, url|
@@ -165,4 +177,4 @@ module Bitly
       end
     end
   end
-end
+end

data/lib/bitly/version.rb

@@ -1,3 +1,3 @@
 module Bitly
-  VERSION = '0.6.1'
+  VERSION = '0.6.2'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bitly
 version: !ruby/object:Gem::Version 
-  hash: 5
-  prerelease: 
+  hash: 3
+  prerelease: false
   segments: 
   - 0
   - 6
-  - 1
-  version: 0.6.1
+  - 2
+  version: 0.6.2
 platform: ruby
 authors: 
 - Phil Nash
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-12 00:00:00 +00:00
+date: 2011-11-10 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,9 +45,9 @@ dependencies:
         hash: 15
         segments: 
         - 0
-        - 5
-        - 2
-        version: 0.5.2
+        - 7
+        - 6
+        version: 0.7.6
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -73,7 +73,7 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README.txt
+- README.md
 - lib/bitly.rb
 - lib/bitly/client.rb
 - lib/bitly/url.rb
@@ -93,7 +93,7 @@ extra_rdoc_files:
 files: 
 - History.txt
 - Manifest
-- README.txt
+- README.md
 - Rakefile
 - bitly.gemspec
 - lib/bitly.rb
@@ -135,7 +135,7 @@ rdoc_options:
 - --title
 - Bitly
 - --main
-- README.txt
+- README.md
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -160,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: bitly
-rubygems_version: 1.4.1
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Use the bit.ly API to shorten or expand URLs

data/README.txt

@@ -1,87 +0,0 @@
-= bitly
-
-== DESCRIPTION:
-
-A Ruby API for http://bit.ly (and now http://j.mp)
-
-http://code.google.com/p/bitly-api/wiki/ApiDocumentation
-
-== NOTE:
-
-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.
-
-To move to using the version 3 API, call:
-
-Bitly.use_api_version_3
-
-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://api.bit.ly for details.
-
-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.
-
-(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 realised it would break everything.)
-
-== INSTALLATION:
-
-gem install bitly
-
-== USAGE:
-
-=== Version 2 API
-
-Create a Bitly client using your username and api key as follows:
-
-bitly = Bitly.new(username, api_key)
-
-You can then use that client to shorten or expand urls or return more information or statistics as so:
-
-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')
-
-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.
-
-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.
-
-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')
-
-=== Version 3 API
-
-Please see the Bit.ly API documentation http://api.bit.ly for details on the V3 API
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2009 Phil Nash
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.