Renamed Buff internals to Buffer

zph · zph · commit 611264f2e5d0 · 2014-09-05T08:53:51.000-04:00
diff --git a/.gitignore b/.gitignore
@@ -20,4 +20,4 @@ notes.txt
 spec/fixtures/updates_by_profile_id_sent.txt
 utility.rb
 tags
-vendor/
+vendor
diff --git a/Gemfile b/Gemfile
@@ -1,5 +1,4 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in buff.gemspec
 gem 'coveralls', require: false
 gemspec
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# Buff
+# buffer
 
-Buff is a Buffer API Wrapper written in Ruby.  It provides more thorough API coverage than the existing gem.
+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.
 
@@ -15,25 +15,25 @@ Or
 
 Add this line to your application's Gemfile to include HEAD code:
 
-`gem 'buff', :github => 'bufferapp/buffer-ruby'`
+`gem 'buffer', :github => 'bufferapp/buffer-ruby'`
 
 And then execute:
 
 `$ bundle`
 
 Or install RubyGems version, which will receive more attention to stability:
 
-`$ gem install buff`
+`$ gem install buffer`
 
 ## Usage
 
-  * 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 Buff reaches v0.1.0 and submit issues on Github Issues tab.
+  * 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:
-    `buff Super witty stuff that fits in 140 chars`
+    `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 `~/.bufferapprc` in the following layout.  This allows the `ACCESS_TOKEN` to be loaded into `Buff::ACCESS_TOKEN`:
+  * For convenience load credentials into `~/.bufferapprc` in the following layout.  This allows the `ACCESS_TOKEN` to be loaded into `buffer::ACCESS_TOKEN`:
 
 
 ```
diff --git a/bin/buffer b/bin/buffer
@@ -2,7 +2,7 @@
 
 $LOAD_PATH.unshift(File.dirname(__FILE__), '..', 'lib')
 
-require 'buff'
+require 'buffer'
 
 begin
   require 'yaml'
@@ -24,8 +24,8 @@ rescue
   puts "Please upgrade from older config file structure" if ENV['BUFF_DEBUG']
 end
 
-client = Buff::Client.new(options['access_token'])
+client = Buffer::Client.new(options['access_token'])
 id = client.profiles[options['profile_index'].to_i].id
 
-response = client.create_update(body: {text: ARGV.join(" "), profile_ids: [ id ] })
+response = client.create_update(body: {text: ARGF.chomp, profile_ids: [ id ] } )
 puts response if ENV['BUFF_DEBUG']
diff --git a/buffer.gemspec b/buffer.gemspec
@@ -1,16 +1,16 @@
 # -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'buff/version'
+require 'buffer/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "buff"
-  gem.version       = Buff::VERSION
+  gem.name          = "buffer"
+  gem.version       = Buffer::VERSION
   gem.authors       = ["ZPH"]
   gem.email         = ["Zander@civet.ws"]
-  gem.description   = %q{Buff is an API Wrapper Gem for Bufferapp.com's API}
-  gem.summary       = %q{Buff is an API Wrapper Gem for Bufferapp.com's API}
-  gem.homepage      = "http://github.com/zph/buff"
+  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.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
diff --git a/lib/buffer.rb b/lib/buffer.rb
@@ -0,0 +1,21 @@
+require "faraday"
+require "faraday_middleware"
+require "json"
+require "rash"
+require "addressable/uri"
+
+require "buffer/version"
+require "buffer/core"
+require "buffer/user"
+require "buffer/profile"
+require "buffer/update"
+require "buffer/link"
+require "buffer/error"
+require "buffer/encode"
+require "buffer/datastructure"
+require "buffer/info"
+require "buffer/client"
+require "buffer/setup"
+
+module Buffer
+end
diff --git a/lib/buffer/client.rb b/lib/buffer/client.rb
@@ -1,4 +1,4 @@
-module Buff
+module Buffer
   class Client
     include Core
     include User
diff --git a/lib/buffer/core.rb b/lib/buffer/core.rb
@@ -1,6 +1,6 @@
 require 'pathname'
 
-module Buff
+module Buffer
   begin
     #TODO: change from #expand_path to Pathname if appropriate
     # if File.exists?(File.expand_path("~/.bufferapprc"))
@@ -58,7 +58,7 @@ def interpret_response(response)
 
       def handle_response_code(response)
         error = Hashie::Mash.new(response.body)
-        raise Buff::Error::APIError unless error.code
+        raise Buffer::Error::APIError unless error.code
         "Buffer API Error Code: #{error.code}\n" +
         "HTTP Code: #{response.code}." +
         "Description: #{error.error}"
diff --git a/lib/buffer/datastructure.rb b/lib/buffer/datastructure.rb
@@ -1,4 +1,4 @@
-module Buff
+module Buffer
   class UserInfo < Hashie::Mash; end
   class Profile  < Hashie::Mash; end
   class Response < Hashie::Mash; end
diff --git a/lib/buffer/encode.rb b/lib/buffer/encode.rb
@@ -1,4 +1,4 @@
-module Buff
+module Buffer
   class Encode
     class << self
       def encode(arg)
diff --git a/lib/buffer/error.rb b/lib/buffer/error.rb
@@ -1,4 +1,4 @@
-module Buff
+module Buffer
   module Error
     ConfigFileMissing = Class.new(StandardError)
     InvalidIdLength = Class.new(ArgumentError)
diff --git a/lib/buffer/info.rb b/lib/buffer/info.rb
@@ -1,9 +1,9 @@
-module Buff
+module Buffer
   class Client
     module Info
       def info
         response = get("/info/configuration.json")
-        Buff::Info.new(response)
+        Buffer::Info.new(response)
       end
     end
   end
diff --git a/lib/buffer/link.rb b/lib/buffer/link.rb
@@ -1,9 +1,9 @@
-module Buff
+module Buffer
   class Client
     module Link
       def link(options)
         response = get("/links/shares.json", options)
-        Buff::Link.new(response)
+        Buffer::Link.new(response)
       end
     end
   end
diff --git a/lib/buffer/profile.rb b/lib/buffer/profile.rb
@@ -1,23 +1,23 @@
-module Buff
+module Buffer
   class Client
     module Profile
       def profiles
         response = get("/profiles.json")
-        response.map { |profile| Buff::Profile.new(profile) }
+        response.map { |profile| Buffer::Profile.new(profile) }
       end
 
       def profile_by_id(id)
         response = get("/profiles/#{id}.json")
-        Buff::Profile.new(response)
+        Buffer::Profile.new(response)
       end
 
       def schedules_by_profile_id(id)
         response = get("/profiles/#{id}/schedules.json")
-        response.map { |a_response| Buff::Schedule.new(a_response) }
+        response.map { |a_response| Buffer::Schedule.new(a_response) }
       end
 
       def set_schedules(id, options)
-        schedules = Buff::Encode.encode(
+        schedules = Buffer::Encode.encode(
                         options.fetch(:schedules) { raise ArgumentError })
         post("/profiles/#{id}/schedules/update.json",
                         body: { schedules: schedules })
diff --git a/lib/buffer/setup.rb b/lib/buffer/setup.rb
@@ -1,4 +1,4 @@
-module Buff
+module Buffer
   RC_VERSION = "0.0.1"
   class Setup
 
@@ -7,7 +7,7 @@ def initialize(args="~/.bufferapprc")
       if exists?
         @content = YAML.load_file(File.expand_path path)
       else
-        raise Buff::Error::ConfigFileMissing
+        raise Buffer::Error::ConfigFileMissing
       end
     end
 
diff --git a/lib/buffer/update.rb b/lib/buffer/update.rb
@@ -1,20 +1,20 @@
-module Buff
+module Buffer
   class Client
     module Update
       def update_by_id(id, options = {})
         check_id(id)
         response = get("/updates/#{id}.json")
-        Buff::Update.new(response)
+        Buffer::Update.new(response)
       end
 
       def updates_by_profile_id(id, options = {})
         status = options.fetch(:status) do
-          raise Buff::Error::MissingStatus, "Include :pending or :sent in args"
+          raise Buffer::Error::MissingStatus, "Include :pending or :sent in args"
         end
         options.delete(:status)
         response = get("/profiles/#{id}/updates/#{status.to_s}.json", options)
-        updates = response['updates'].map { |r| Buff::Update.new(r) }
-        Buff::Updates.new (
+        updates = response['updates'].map { |r| Buffer::Update.new(r) }
+        Buffer::Updates.new (
               { total: response['total'],
                 updates: updates }
         )
@@ -24,9 +24,9 @@ def interactions_by_update_id(id, options = {})
         check_id(id)
         response = get("/updates/#{id}/interactions.json", options)
         interactions = response['interactions'].map do |r|
-          Buff::Interaction.new(r)
+          Buffer::Interaction.new(r)
         end
-        Buff::Interactions.new(
+        Buffer::Interactions.new(
           { total: response['total'], interactions: interactions }
         )
       end
@@ -67,8 +67,8 @@ def destroy_update(update_id)
       end
 
       def check_id(id)
-        raise Buff::Error::InvalidIdLength unless id.length == 24
-        raise Buff::Error::InvalidIdContent unless id[/^[a-f0-9]+$/i]
+        raise Buffer::Error::InvalidIdLength unless id.length == 24
+        raise Buffer::Error::InvalidIdContent unless id[/^[a-f0-9]+$/i]
       end
     end
   end
diff --git a/lib/buffer/user.rb b/lib/buffer/user.rb
@@ -1,8 +1,8 @@
-module Buff
+module Buffer
   class Client
     module User
       def user_info(options = {})
-        Buff::UserInfo.new(get("/user.json"))
+        Buffer::UserInfo.new(get("/user.json"))
       end
     end
   end
diff --git a/lib/buffer/version.rb b/lib/buffer/version.rb
@@ -1,3 +1,3 @@
-module Buff
+module Buffer
   VERSION = "0.0.6"
 end
diff --git a/spec/lib/buff/encode_spec.rb b/spec/lib/buff/encode_spec.rb
@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe Buff::Encode do
+describe Buffer::Encode do
 
   context "successful code" do
 
@@ -15,22 +15,22 @@
 
   describe "#encode"
     it "converts to match Buffer API specs encoding" do
-      Buff::Encode.encode([short_schedule]).
+      Buffer::Encode.encode([short_schedule]).
         should eq(schedules_encoded.gsub(/:/, '%3A'))
     end
 
     it "processes an input array of schedules" do
-      Buff::Encode.encode([very_short_schedule, very_short_schedule]).
+      Buffer::Encode.encode([very_short_schedule, very_short_schedule]).
         should eq("schedules[0][days][]=sun&schedules[0][days][]=sat&schedules[0][times][]=09%3A00&schedules[0][times][]=24%3A00&schedules[1][days][]=sun&schedules[1][days][]=sat&schedules[1][times][]=09%3A00&schedules[1][times][]=24%3A00")
     end
 
     it "includes index in conversion when multiple schedules present" do
-      Buff::Encode.encode([very_short_schedule, very_short_schedule, very_short_schedule]).
+      Buffer::Encode.encode([very_short_schedule, very_short_schedule, very_short_schedule]).
         should eq("schedules[0][days][]=sun&schedules[0][days][]=sat&schedules[0][times][]=09%3A00&schedules[0][times][]=24%3A00&schedules[1][days][]=sun&schedules[1][days][]=sat&schedules[1][times][]=09%3A00&schedules[1][times][]=24%3A00&schedules[2][days][]=sun&schedules[2][days][]=sat&schedules[2][times][]=09%3A00&schedules[2][times][]=24%3A00")
     end
 
     it "processes an input hash" do
-      Buff::Encode.encode({ schedules: [very_short_schedule, very_short_schedule, very_short_schedule] }).
+      Buffer::Encode.encode({ schedules: [very_short_schedule, very_short_schedule, very_short_schedule] }).
         should eq("schedules[0][days][]=sun&schedules[0][days][]=sat&schedules[0][times][]=09%3A00&schedules[0][times][]=24%3A00&schedules[1][days][]=sun&schedules[1][days][]=sat&schedules[1][times][]=09%3A00&schedules[1][times][]=24%3A00&schedules[2][days][]=sun&schedules[2][days][]=sat&schedules[2][times][]=09%3A00&schedules[2][times][]=24%3A00")
     end
   end
diff --git a/spec/lib/buff/link_spec.rb b/spec/lib/buff/link_spec.rb
@@ -1,8 +1,8 @@
 require 'spec_helper'
 
-describe Buff::Client do
+describe Buffer::Client do
   describe "#link" do
-    let(:client) { Buff::Client.new("some_token") }
+    let(:client) { Buffer::Client.new("some_token") }
     let(:url) { %q{http://bufferapp.com} }
 
     before do
diff --git a/spec/lib/buff/profile_spec.rb b/spec/lib/buff/profile_spec.rb
@@ -1,14 +1,14 @@
 require 'spec_helper'
 
-describe Buff::Client::Profile do
+describe Buffer::Client::Profile do
   let(:id) { "5160746d54f04a5e3a00000f" }
 
   subject do
-    Buff::Client.new("some_token")
+    Buffer::Client.new("some_token")
   end
 
   describe "#profiles" do
-    let(:rash) { Buff::Client.new("some_token").profiles }
+    let(:rash) { Buffer::Client.new("some_token").profiles }
 
     before(:each) do
       url = "#{ base_path }/profiles.json"
@@ -20,7 +20,7 @@
     end
 
     it "returns a Rash collection object" do
-      rash[0].class.should eq(Buff::Profile)
+      rash[0].class.should eq(Buffer::Profile)
     end
 
     it "provides an accessor for plan" do
@@ -36,10 +36,10 @@
       stub_with_to_return(:get, url, fixture_name)
     end
 
-    let(:rash) { Buff::Client.new("some_token").profile_by_id(id) }
+    let(:rash) { Buffer::Client.new("some_token").profile_by_id(id) }
 
     it "returns a rash collection" do
-      rash.class.should eq(Buff::Profile)
+      rash.class.should eq(Buffer::Profile)
     end
 
     it "accesses formatted service" do
@@ -54,10 +54,10 @@
       stub_with_to_return(:get, url, fixture_name)
     end
 
-    let(:rash) { Buff::Client.new("some_token").schedules_by_profile_id(id) }
+    let(:rash) { Buffer::Client.new("some_token").schedules_by_profile_id(id) }
 
     it "returns a rash collection" do
-      rash[0].class.should eq(Buff::Schedule)
+      rash[0].class.should eq(Buffer::Schedule)
     end
 
     it "accesses days" do
diff --git a/spec/lib/buff/schedule_spec.rb b/spec/lib/buff/schedule_spec.rb
diff --git a/spec/lib/buff/setup_spec.rb b/spec/lib/buff/setup_spec.rb
diff --git a/spec/lib/buff/update_spec.rb b/spec/lib/buff/update_spec.rb
diff --git a/spec/lib/buff/user_spec.rb b/spec/lib/buff/user_spec.rb
diff --git a/spec/lib/buff_spec.rb b/spec/lib/buff_spec.rb
diff --git a/spec/lib/core_spec.rb b/spec/lib/core_spec.rb
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-module Buff`
	`1`	`+module Buffer`
`2`	`2`	`class Client`
`3`	`3`	`include Core`
`4`	`4`	`include User`