bitly_exporter 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 95a9394ccb7997614591c04f4cbbcab2a0de051c
+  data.tar.gz: abda5797e29b1964f2d9253a4e7bc3af3419cc59
+SHA512:
+  metadata.gz: b1098b6ce86fa57019114c8587d5b46c29905c23600e79c57a56ddbce8a96d7c7013a3eeab2ff86fd760884bd6172c141634a7ce71189e82e9702117e0436700
+  data.tar.gz: 18287adf2a886dd353a888a0ab0fb4efb950f45bc0ebabb8b279ba12fd19c112edf592be7ea9575377074523e3ca1eb6a4b05fdecc673eede43c4cdf3f49c828

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+pkg/
+Gemfile.lock
+coverage/
+.coveralls.yml

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Aaron Ortbals
+
+MIT License
+
+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/README.md

@@ -0,0 +1,95 @@
+Bitly Exporter
+==============
+
+[![Code Climate](https://codeclimate.com/github/aortbals/bitly_exporter.png)](https://codeclimate.com/github/aortbals/bitly_exporter) [![Coverage Status](https://coveralls.io/repos/aortbals/bitly_exporter/badge.png?branch=master)](https://coveralls.io/r/aortbals/bitly_exporter?branch=master)
+
+This gem exports a user's links from the Bitly V3 API. It requires a generic OAuth access token that you can [obtain from Bitly](https://bitly.com/a/oauth_apps). It makes use of the [User Link History API](http://dev.bitly.com/user_info.html#v3_user_link_history).
+
+
+Installation
+------------
+
+Add this line to your applications Gemfile:
+
+    gem 'bitly_exporter', github: 'aortbals/bitly_exporter'
+
+Or install it directly:
+
+    gem install bitly_exporter
+
+
+Usage
+-----
+
+First, create a user and an exporter:
+
+    user = BitlyExporter::User.new('youroauthaccesstoken')
+    exporter = BitlyExporter::Exporter.new(user)
+
+The `export` method triggers the export. There are two ways to consume the results.
+
+Using a block:
+
+```ruby
+exporter.export do |link|
+  # Create a record, store the link, etc
+end
+```
+
+As a traditional method:
+
+```ruby
+results = exporter.export
+
+results.each_with_index do |link, index|
+  puts "Link Index: #{index}, Link: #{link.link}"
+end
+```
+
+`export` takes two optional arguments: `progress` & `max`. Set `progress` to `true` to see progress while exporting. Setting `max` will import (in increments of 100) up to the maximum specified. This is a good way to see a sample response.
+
+Show progress:
+
+```ruby
+results = exporter.export(true)
+```
+
+With max:
+
+```ruby
+exporter.export(false, 200) do |link|
+  # Create a record, store the link, etc
+end
+```
+
+#### Link Objects ####
+
+See the [API docs](http://dev.bitly.com/user_info.html#v3_user_link_history) for more information. A link object has the following methods:
+
+- link (short_link)
+- long_url
+- aggregate\_link (global\_bitly\_identifier)
+- archived
+- title
+- private
+- client_id
+- created_at
+- modified_at
+- user_ts
+
+
+Contributing
+------------
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Write Tests
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request
+
+
+License
+-------
+
+This code is provided under the MIT license.  See LICENSE for more details.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/bitly_exporter.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bitly_exporter/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "bitly_exporter"
+  gem.version       = BitlyExporter::VERSION
+  gem.authors       = ["Aaron Ortbals"]
+  gem.email         = ["me@aaronortbals.com"]
+  gem.description   = %q{Export a user's links from Bitly.}
+  gem.summary       = %q{Supports Bitly API V3}
+  gem.homepage      = "https://github.com/aortbals/bitly_exporter"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'coveralls'
+
+  gem.add_dependency 'httparty'
+end

data/lib/bitly_exporter/client.rb

@@ -0,0 +1,28 @@
+require 'httparty'
+require 'json'
+
+module BitlyExporter
+  class Client
+    include HTTParty
+    
+    API_URL     = "https://api-ssl.bitly.com/v3"
+    API_VERSION = 3
+
+    attr_reader :oauth_token, :params
+    def initialize(oauth_token)
+      @oauth_token = oauth_token
+      @params = { access_token: oauth_token }
+    end
+
+    protected
+
+    def make_request(endpoint, options={})
+      response = HTTParty.get("#{API_URL}#{endpoint}", query: params.merge(options))
+      if response.code == 200
+        JSON.parse(response.body)
+      else
+        raise StandardError, "The request to bitly failed with a HTTP #{response.code}\n#{response.message}"
+      end
+    end    
+  end
+end

data/lib/bitly_exporter/exporter.rb

@@ -0,0 +1,28 @@
+module BitlyExporter
+  class Exporter
+    LIMIT  = 100
+    NO_MAX = Float::INFINITY
+
+    attr_reader :user
+    def initialize(user)
+      @user = user
+    end
+
+    def export(progress=false, max=NO_MAX)
+      results = []
+      offset  = 0
+      begin
+        links, result_count = user.link_history(limit: LIMIT, offset: offset)
+        links.each do |link|
+          results << link
+          yield link if block_given?
+        end
+        offset = offset + LIMIT
+        sleep(0.5) # Let's not bull rush the API
+        print "#{offset} links retrieved...\r" if progress
+      end while links.count > 0 && offset < max
+      print "Finished. #{results.count} links retrieved." if progress
+      results
+    end
+  end
+end

data/lib/bitly_exporter/link.rb

@@ -0,0 +1,22 @@
+module BitlyExporter
+  class Link
+    attr_reader  :link, :long_url, :aggregate_link, :title, :private, :created_at, :modified_at
+    alias_method :short_link, :link
+    alias_method :global_bitly_identifier, :aggregate_link
+
+    def initialize(data={})
+      if data
+        @link           = data["link"]
+        @long_url       = data["long_url"]
+        @aggregate_link = data["aggregate_link"]
+        @archived       = data["archived"] 
+        @title          = data["title"]
+        @private        = data["private"]
+        @client_id      = data["client_id"]
+        @created_at     = Time.at(data["created_at"])   if data["created_at"]
+        @modified_at    = Time.at(data["modified_at"])  if data["modified_at"]
+        @user_ts        = Time.at(data["user_ts"])      if data["user_ts"]
+      end
+    end
+  end
+end

data/lib/bitly_exporter/user.rb

@@ -0,0 +1,19 @@
+module BitlyExporter
+  class User < Client 
+    def link_history(options={})
+      result = make_request("/user/link_history", options)
+      result_count = result["data"]["result_count"]
+      result_links = result["data"]["link_history"]
+      
+      links = result_links.collect do |link|
+        Link.new(link)
+      end
+      
+      return links, result_count
+    end
+
+    def info(options={})
+      make_request("/user/info")
+    end
+  end
+end

data/lib/bitly_exporter/version.rb

@@ -0,0 +1,3 @@
+module BitlyExporter
+  VERSION = "0.0.1.pre"
+end

data/lib/bitly_exporter.rb

@@ -0,0 +1,8 @@
+require "bitly_exporter/version"
+require "bitly_exporter/link"
+require "bitly_exporter/client"
+require "bitly_exporter/user"
+require "bitly_exporter/exporter"
+
+module BitlyExporter
+end