buffer 0.0.1 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d9793acd4e784b551ab7fc634b25c6b6405e34f0
+  data.tar.gz: 52b18271fe05f996e8de43e55113f3e6acef5900
+SHA512:
+  metadata.gz: a1144545ae627a84a30dfe1b2864fa25a14cf4851c3979a6fb5a359043425de4ee3acf6d3eb9ca23f3f32300a46311015c8ce3b62da6c67a0dd518d7ce7d12db
+  data.tar.gz: e26756d5d8a66ff72ab437039c239914faa37d2c0df7203f38ba38ce727bbb841fc8618b63f47d928f27bbd4d47f5a646eb0b240270a794583fdcd86428e3a74

data/.bufferapprc.template

@@ -0,0 +1,23 @@
+---
+access_token: ASDFASDFASDF
+profile_index: 0
+version: 0.0.1
+
+# How to Get Started:
+# Create a Developer API Token here: http://bufferapp.com/developers/apps/create.
+# Fill in Stuff. Your answers don't matter much for the purpose of this rudimentary setup.
+# Submit that form and wait a short period (~2 min )
+# Visit: http://bufferapp.com/developers/apps
+# Gather Access Token and place it after the word "access_token"
+# Copy this file to the root of your user's home folder:
+# Set "profile_index" to 0 if you only have one account to post to. Otherwise it's more complicated ;). Find me on Twitter and I can explain (@_ZPH).
+#   - ~/.bufferapprc
+
+# Structure:
+# access_token: Access Token
+# profile_index: Buffer Account number, ie posting to first account in list, use 0 (ie zero)
+#
+#TODO: improve instructions
+# remove need for user to create their own App on bufferapp.com
+# Future versions will integrate with Buffer-OAuth system.
+

data/.gitignore

@@ -15,3 +15,9 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+notes.txt
+.DS_STORE
+spec/fixtures/updates_by_profile_id_sent.txt
+utility.rb
+tags
+vendor

data/.rubocop.yml

@@ -0,0 +1,18 @@
+Encoding:
+  Enabled: true
+
+LineLength:
+  Enabled: true
+  Max: 79
+
+StringLiterals:
+  Enabled: false
+
+AllCops:
+  # Includes:
+  Excludes:
+    - spec/**
+    - bin/**
+    - utility.rb
+    - Rakefile
+    - tmp/*

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+env:
+  - TRAVIS_CI=true

data/API_COVERAGE.md

@@ -0,0 +1,19 @@
+## Fully Implemented API Requests
+    GET https://api.bufferapp.com/1/user.json
+    GET https://api.bufferapp.com/1/profiles.json
+    GET https://api.bufferapp.com/1/profiles/4eb854340acb04e870000010.json
+    GET https://api.bufferapp.com/1/profiles/4eb854340acb04e870000010/schedules.json
+    GET https://api.bufferapp.com/1/updates/4eb8565e0acb04bb82000004.json
+    POST https://api.bufferapp.com/1/updates/4ecda256512f7ee521000001/share.json
+    POST https://api.bufferapp.com/1/updates/4ecda256512f7ee521000004/destroy.json
+    POST https://api.bufferapp.com/1/profiles/4eb854340acb04e870000010/schedules/update.json
+    GET https://api.bufferapp.com/1/profiles/4eb854340acb04e870000010/updates/pending.json
+    GET https://api.bufferapp.com/1/profiles/4eb854340acb04e870000010/updates/sent.json
+    GET https://api.bufferapp.com/1/updates/4ecda476542f7ee521000006/interactions.json
+    POST https://api.bufferapp.com/1/profiles/4eb854340acb04e870000010/updates/shuffle.json
+    POST https://api.bufferapp.com/1/updates/create.json
+    POST https://api.bufferapp.com/1/updates/4ecda256512f7ee521000004/update.json
+    POST https://api.bufferapp.com/1/profiles/4eb854340acb04e870000010/updates/reorder.json
+
+## Untested Optional Params
+

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in buffer.gemspec
+gem 'coveralls', require: false
 gemspec

data/Guardfile

@@ -0,0 +1,10 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+end
+

data/{LICENSE → LICENSE.txt}

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Tom Ashworth
+Copyright (c) 2013 ZPH
 
 MIT License
 

data/README.md

@@ -1,117 +1,99 @@
-# Buffer
+# buffer
 
-Official API wrapper for [Buffer](http://bufferapp.com) covering user & profile management and adding, removing & editing updates, and more planned endpoints. See the [full API Documentation](http://bufferapp.com/developers/api/) for more.
+buffer is a Buffer API Wrapper written in Ruby.  It provides more thorough API coverage than the existing gem.
+
+Since the gem is currently in ALPHA development, the interface is prone to change.  Please wait until v0.1.0 is released to become reliant on interface. As it stands, all of the basic API calls in BufferApp's spec are available.  Some of the optional params are yet to be implemented.
 
-For a Buffer OmniAuth strategy for authenticating your users with Buffer, see [omniauth-buffer2](/bufferapp/omniauth-buffer2).
 
 ## Installation
 
-Add this line to your application's Gemfile:
+[![Coverage Status](https://coveralls.io/repos/zph/buff/badge.png?branch=master)](https://coveralls.io/r/zph/buff?branch=master) [![Build Status](https://travis-ci.org/zph/buff.png?branch=master)](https://travis-ci.org/zph/buff) [![Code Climate](https://codeclimate.com/github/zph/buff.png)](https://codeclimate.com/github/zph/buff)
 
-    gem 'buffer'
+For now please `git clone git@github.com:bufferapp/buffer-ruby.git` the repo
 
-And then execute:
+Or
 
-    $ bundle
+Add this line to your application's Gemfile to include HEAD code:
 
-Or install it yourself as:
+`gem 'buffer', :github => 'bufferapp/buffer-ruby'`
 
-    $ gem install buffer
+And then execute:
 
-## Usage
+`$ bundle`
 
-### Client
+Or install RubyGems version, which will receive more attention to stability:
 
-The most basic usage of the wrapper involves creating a `Buffer::Client` and then making requests through that object. Since all requests to the Buffer API require an access token you must have first authorized a Buffer user, or otherwise have an access token. The [Buffer OmniAuth Strategy](http://github.com/bufferapp/omniauth-buffer2) can help with this.
+`$ gem install buffer`
 
-Use the Client if you just want to have full control over your `get` and `post` requests.
+## Usage
 
-Creating a new client is simple:
+  * All methods are tested with Rspec and WebMock. Most methods do not have integration tests that reach out to the live Buffer API servers.  Proceed with caution until buffer reaches v0.1.0 and submit issues on Github Issues tab.
+  * Authentication is not included in this gem (Try OAuth-buffer2) or use the single API key given when registering your own Buffer Dev credentials.
+  * Commandline bin is provided to enable posting of updates:
+    `buffer Super witty stuff that fits in 140 chars`
+    Will post to your first account when setup following instructions below.
+    _A more convenient setup is planned in future releases._
+  * For convenience load credentials into environment as ENV variables:
 
-```ruby
-buffer = Buffer::Client.new access_token
 ```
-
-### User
-
-The User object makes working with users easier by providing some useful shortcuts to user information, like `id`, and data, like `profiles`. It provides the all the methods specified in the Client as it inherits from it.
-
-The User introduces some caching of requests. These are invalidated when a `post` request is made to an endpoint that might affect the data. You can force cache invalidation of one or all endpoints using the `invalidate` method.
-
-**Note: Currently only `invalidate` is implemented. If you make a POST request that changes a user object you must manually invalidate the cache**.
-
-Creating a new user:
-
-```ruby
-user = Buffer::User.new access_token
+export BUFFER_ACCESS_TOKEN="1/jjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjj" # (BufferApp OAuth Access Token)
+export BUFFER_PROFILE_ID="0"                                    # (default of 0)
 ```
 
-## API
+## Access Token Instructions
 
-You can use a client, or any subclass, to make GET & POST requests to the Buffer API. The exposed API methods are `get`, `post` and, the lowest level, `api`. 
+#### How to Get Started:
 
-#### api
+* Create a Developer API Token here: http://bufferapp.com/developers/apps/create.
+* Fill in Stuff. Your answers don't matter much for the purpose of this rudimentary setup.
+* Submit that form and wait a short period (~2 min )
+* Visit: http://bufferapp.com/developers/apps
+* Gather Access Token and place it after the word "access_token"
+* Set BUFFER_PROFILE_ID="0" if you only have one account to post to. Otherwise it's more complicated ;). Find me on Twitter and I can explain [@_ZPH](https://twitter.com/_ZPH).
 
-`api` is the method at the root of the API, handling all requests.
+## TODO:
 
-```ruby
-api (symbol) method, (string) url, (hash, optional) params, (hash or array, optional) data
-# for example:
-buffer.api :get, 'user'
-```
+* Improve instructions
 
-`method` must be either `:get` or `:post`
+#### Future versions will integrate with Buffer-OAuth system.
+* Integrate Launchy for the purpose of launching browser window.
+* Possible to model behavior on [ t.gem ](https://github.com/sferik/t/blob/master/lib/t/cli.rb#L56-L113)
 
-#### get
+#### Raise error if message is beyond the character limit.
+* Accomplish this via [ Twitter Text library ](https://github.com/twitter/twitter-text-rb)
+* Refactor to simplify use of default params
 
-```ruby
-user_data = buffer.get 'user'
-user_profiles = buffer.get 'profiles'
-```
-
-`get` is just a thin layer over `api`, so the above is equivalent to:
+## API Coverage
 
-```ruby
-user_data = buffer.api :get, 'user'
-user_profiles = buffer.api :get, 'profiles'
-```
+#### Implemented
 
-#### `post`
+* User
+* Profiles (:get, :post)
+* Updates (:get, :post)
+* Links
+* Info
+* Error Codes
 
-```ruby
-user_data = buffer.post 'updates/create', :text => "Hello, world!", :profile_ids => ['123abc456', '789def123']
-```
+Further Details [API Coverage](API_COVERAGE.md)
 
-`post` is also a wrapper for `api`, so the above becomes:
+#### Not Implemented
 
-```ruby
-user_data = buffer.api :post, 'updates/create', :text => "Hello, world!", :profile_ids => ['123abc456', '789def123']
-```
+* Caching
 
-## User API
+## Supported Ruby Implementations
+- MRI 2.0.0
+- Others likely work but are not included in CI Server
 
-#### `id`, `created_at`...
+## Contributing
 
-The User object allows access to the data from the user endpoint in manner of a normal ruby accessor. This makes accessing user info very easy, like the following:
+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. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
 
-```ruby
-user.id
-user.created_at
-```
-
-#### `profiles` **not implemented**
-
-`profiles` is a helper method that gives you access to the profiles associated with a particular user. It's shorthand for `get 'profiles'` with caching. The
-
-`profiles` is invalidated by any `post` request made to a child of the `profiles` endpoing, like `/profiles/:id/schedules/update`.
-
-```ruby
-user.profiles                 # all a user's profiles
-user.profiles '123abc456def'  # return a profile with a specific id
-```
+Issues, refactoring, and feedback are all welcome.
 
-## Todo
+Also, this project is newcomer friendly!! We'd love to be your first Open Source Software contribution and would be happy to assist in that process.
 
-* `user.profiles`
-* Automatic cache invalidation after post request
-* Move cache handling to a mixin
+Crafted with care by Zander. Reach out and say hi at [@_ZPH](http://twitter.com/_ZPH) or [civet.ws](http://www.civet.ws)

data/Rakefile

@@ -1,2 +1,26 @@
-#!/usr/bin/env rake
 require "bundler/gem_tasks"
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
+end
+
+desc "Generate code coverage"
+RSpec::Core::RakeTask.new(:coverage) do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  t.rcov = true
+  t.rcov_opts = %w[--exclude spec]
+end
+
+task :default  => :spec
+
+task :curl_dump, [ :url ] do |t, args|
+  access_token = `cat ~/.bufferapprc | head -3 | tail -1`.chomp
+  sh "curl -is #{args[:url]}?access_token=#{access_token}"
+end

data/TODO.md

@@ -0,0 +1,3 @@
+Improve Interface for #create_update to not need :body in args
+Add error if message is obviously above 140 char
+- Extra feature to shorten web links to length used by t.co

data/bin/buffer

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+require 'buffer'
+require 'logger'
+
+log_level = ENV['BUFFER_DEBUG'] ? Logger::INFO : Logger::ERROR
+
+LOG = Logger.new(STDOUT) { |l| l.log_level = log_level }
+
+def gather_message(argv)
+  args = argv.dup
+  case args.count
+  when 0 then abort("Please supply a message for Buffer Post.")
+  when 1 then args.first
+  else
+    args.join(" ")
+  end
+end
+
+def main
+  token = Env.BUFFER_ACCESS_TOKEN
+  profile = Integer(ENV.fetch('BUFFER_PROFILE_ID', "0"))
+
+  message = gather_message(ARGV)
+  client = Buffer::Client.new(token)
+  profile_id = client.profiles[profile].id
+  post_args = {text: message, profile_ids: [profile_id]}
+  LOG.info('#main.post_args') { post_args }
+  unless ENV['BUFFER_DEBUG']
+    client.create_update(body: post_args)
+    puts "Posted message."
+  end
+end
+
+main

data/buffer.gemspec

@@ -1,26 +1,36 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/buffer/version', __FILE__)
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'buffer/version'
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Tom Ashworth"]
-  gem.email         = ["tom@phuu.net"]
-  gem.description   = "Buffer API wrapper for Ruby"
-  gem.summary       = "Buffer API wrapper for Ruby"
-  gem.homepage      = ""
+  gem.name          = "buffer"
+  gem.version       = Buffer::VERSION
+  gem.authors       = ["ZPH"]
+  gem.email         = ["Zander@civet.ws"]
+  gem.description   = %q{Buffer is an API Wrapper Gem for Bufferapp.com's API}
+  gem.summary       = %q{Buffer is an API Wrapper Gem for Bufferapp.com's API}
+  gem.homepage      = "http://github.com/bufferapp/buffer-ruby"
 
-  gem.files         = `git ls-files`.split($\)
+  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.name          = "buffer"
   gem.require_paths = ["lib"]
-  gem.version       = Buffer::VERSION
 
-  gem.add_dependency "faraday"
-  gem.add_dependency "multi_json"
-  gem.add_dependency "i18n"
-  gem.add_dependency "active_support"
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'guard-bundler'
+  gem.add_development_dependency 'rb-fsevent'
+  gem.add_development_dependency 'growl'
+  gem.add_development_dependency 'pry-uber'
 
-  gem.add_development_dependency "rspec", "~> 2.7"
-  gem.add_development_dependency "simplecov"
-  gem.add_development_dependency "webmock"
+  gem.add_runtime_dependency 'multi_json'
+  gem.add_runtime_dependency 'yajl-ruby'
+  gem.add_runtime_dependency 'faraday_middleware'
+  gem.add_runtime_dependency 'faraday'
+  gem.add_runtime_dependency 'hashie'
+  gem.add_runtime_dependency 'rake'
+  gem.add_runtime_dependency 'addressable'
+  gem.add_runtime_dependency 'environs'
 end

data/lib/buffer/client.rb

@@ -0,0 +1,26 @@
+module Buffer
+  class Client
+    include Core
+    include User
+    include Profile
+    include Update
+    include Link
+    include Info
+
+    attr_accessor :access_token
+
+    def initialize(access_token)
+      @access_token = access_token
+      url = "https://api.bufferapp.com/1/"
+      @connection = Faraday.new(url: url) do |faraday|
+        faraday.request  :url_encoded
+        faraday.adapter  Faraday.default_adapter
+      end
+    end
+
+    def auth_query
+      { access_token: @access_token }
+    end
+
+  end
+end

data/lib/buffer/core.rb

@@ -0,0 +1,64 @@
+require 'pathname'
+
+module Buffer
+  class Client
+    module Core
+      API_VERSION = "1"
+
+      private
+
+      def get(path, options = {})
+        options.merge!(auth_query)
+        response = @connection.get do |req|
+          req.url path.remove_leading_slash
+          req.params = options
+        end
+
+        interpret_response(response)
+      end
+
+      def post(path, options = {})
+        params = merge_auth_token_and_query(options)
+        params.merge!(options)
+        response = @connection.post do |req|
+          req.url path.remove_leading_slash
+          req.headers['Content-Type'] = "application/x-www-form-urlencoded"
+          req.body = options[:body]
+          req.params = params
+        end
+
+        Hashie::Mash.new(JSON.parse response.body)
+      end
+
+      def merge_auth_token_and_query(options)
+        if options[:query]
+          auth_query.merge options[:query]
+        else
+          auth_query
+        end
+      end
+
+      def interpret_response(response)
+        if response.status == 200
+          JSON.parse response.body
+        else
+          handle_response_code(response)
+        end
+      end
+
+      def handle_response_code(response)
+        error = Hashie::Mash.new(response.body)
+        raise Buffer::Error::APIError unless error.code
+        "Buffer API Error Code: #{error.code}\n" +
+        "HTTP Code: #{response.code}." +
+        "Description: #{error.error}"
+      end
+    end
+  end
+end
+
+class String
+  def remove_leading_slash
+    gsub(/^\//, '')
+  end
+end

data/lib/buffer/datastructure.rb

@@ -0,0 +1,18 @@
+module Buffer
+  class UserInfo < Hashie::Mash; end
+  class Profile  < Hashie::Mash; end
+  class Response < Hashie::Mash; end
+  class Update   < Hashie::Mash; end
+  class Updates  < Hashie::Mash; end
+  class Interaction < Hashie::Mash; end
+  class Interactions < Hashie::Mash; end
+  class Link < Hashie::Mash; end
+  class Info < Hashie::Mash; end
+
+  class Schedule < Hashie::Mash; end
+  Schedules = Class.new(Array) do
+    def dump
+      { schedules: self }.to_json
+    end
+  end
+end

data/lib/buffer/encode.rb

@@ -0,0 +1,33 @@
+module Buffer
+  class Encode
+    class << self
+      def encode(arg)
+        raise_error_for_incorrect_input(arg)
+        arg = arg[:schedules] if arg.respond_to?(:keys)
+        arg.map.with_index do |item, index|
+          process_schedule(item, index)
+        end.join("&")
+      end
+
+      private
+
+      def raise_error_for_incorrect_input(arg)
+        unless arg.kind_of?(Hash) || arg.kind_of?(Array)
+          raise ArgumentError, "Input must be/inherit from Hash or Array"
+        end
+      end
+
+      def process_schedule(item, index)
+        pairs_for(item).map do |key, value|
+          "schedules[#{index}][#{key}][]=#{value}"
+        end.join("&")
+      end
+
+      def pairs_for(item)
+        uri = Addressable::URI.new
+        uri.query_values = item
+        uri.query.split("&").map {|p| p.split("=")}
+      end
+    end
+  end
+end

data/lib/buffer/error.rb

@@ -0,0 +1,10 @@
+module Buffer
+  module Error
+    ConfigFileMissing = Class.new(StandardError)
+    InvalidIdLength = Class.new(ArgumentError)
+    InvalidIdContent = Class.new(ArgumentError)
+    MissingStatus = Class.new(ArgumentError)
+    APIError = Class.new(StandardError)
+    UnauthorizedRequest = Class.new(StandardError)
+  end
+end

data/lib/buffer/info.rb

@@ -0,0 +1,10 @@
+module Buffer
+  class Client
+    module Info
+      def info
+        response = get("/info/configuration.json")
+        Buffer::Info.new(response)
+      end
+    end
+  end
+end

data/lib/buffer/link.rb

@@ -0,0 +1,10 @@
+module Buffer
+  class Client
+    module Link
+      def link(options)
+        response = get("/links/shares.json", options)
+        Buffer::Link.new(response)
+      end
+    end
+  end
+end

data/lib/buffer/profile.rb

@@ -0,0 +1,27 @@
+module Buffer
+  class Client
+    module Profile
+      def profiles
+        response = get("/profiles.json")
+        response.map { |profile| Buffer::Profile.new(profile) }
+      end
+
+      def profile_by_id(id)
+        response = get("/profiles/#{id}.json")
+        Buffer::Profile.new(response)
+      end
+
+      def schedules_by_profile_id(id)
+        response = get("/profiles/#{id}/schedules.json")
+        response.map { |a_response| Buffer::Schedule.new(a_response) }
+      end
+
+      def set_schedules(id, options)
+        schedules = Buffer::Encode.encode(
+                        options.fetch(:schedules) { raise ArgumentError })
+        post("/profiles/#{id}/schedules/update.json",
+                        body: { schedules: schedules })
+      end
+    end
+  end
+end