bitballoon 0.1.3 → 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8ffe0d3f3814d0e2a8371fc42af21e94c90d3f2f
+  data.tar.gz: 78d1599d7ef1b65c86afa0acf22a56e62dcc6844
+SHA512:
+  metadata.gz: 6243f00aef2b92f34a259bbe2c8ab7ea40d0edc04b8a85e4c5a52741dc66276e73a7e2a50f1bb8dc81055c2a2c7c27638c88d463e43f83de857d1e80a2315b18
+  data.tar.gz: f22dad8ac289490050d5f3af663c340312237fa151bf20dcde70010554ce497db71abc19614f17af5476f3b9c13e31628afa73db9aecd4621fe5d456985385f2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bitballoon (0.1.0)
+    bitballoon (0.1.4)
       highline
       oauth2 (>= 0.9.2)
       slop
@@ -11,25 +11,23 @@ GEM
   specs:
     addressable (2.3.3)
     crack (0.3.2)
-    faraday (0.8.8)
-      multipart-post (~> 1.2.0)
-    highline (1.6.20)
-    httpauth (0.2.0)
-    jwt (0.1.8)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    highline (1.6.21)
+    jwt (0.1.11)
       multi_json (>= 1.5)
     minitest (5.0.8)
-    multi_json (1.8.2)
+    multi_json (1.9.2)
     multi_xml (0.5.5)
-    multipart-post (1.2.0)
-    oauth2 (0.9.2)
-      faraday (~> 0.8)
-      httpauth (~> 0.2)
-      jwt (~> 0.1.4)
-      multi_json (~> 1.0)
+    multipart-post (2.0.0)
+    oauth2 (0.9.3)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 0.1.8)
+      multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (~> 1.2)
     rack (1.5.2)
-    slop (3.4.6)
+    slop (3.5.0)
     webmock (1.11.0)
       addressable (>= 2.2.7)
       crack (>= 0.3.2)

data/README.md

@@ -3,6 +3,16 @@ BitBalloon Ruby Client
 
 BitBalloon is a hosting service for the programmable web. It understands your documents, processes forms and lets you do deploys, manage forms submissions, inject javascript snippets into sites and do intelligent updates of HTML documents through it's API.
 
+The basic flow to using the ruby client is:
+
+1. Authenticate (via credentials or a previously aquired access token)
+2. Get site (via id)
+3. Deploy
+  * If site has not been deployed to yet, then the above step will throw a `not found` exception, and you'll need to use `bitballoon.sites.create` to create the site and do the initial deploy.
+  * If the site has already been deployed and the above step was successful, you can simply use `site.update` to re-deploy.
+
+If you'd rather, there's also a command line utility to handle most of these steps: `bitballoon deploy`.
+
 Installation
 ============
 
@@ -52,13 +62,15 @@ If you already have an OAuth2 `access_token` you can instantiate the client like
 bitballoon = BitBalloon::Client.new(:access_token => access_token)
 ```
 
-And the client will be ready to do requests. This means that once you've gotten a token via `authorize!` or `authorize_from_credentials!` you can store it and reuse it for later sessions.
+And the client will be ready to do requests without having to use `authorize_from_credentials`. This means that once you've gotten a token via `authorize_from_credentials!` you can store it and reuse it for later sessions.
+
+If you're authenticating via the `access_token` and you'd like to test if you have a valid `access_token`, you can attempt to make a request with the bitballoon client and if the token is invalid, a `BitBalloon::Client::AuthenticationError` will be raised. See Miles Matthias' [BitBalloon Rakefile](https://github.com/milesmatthias/bitballoon-rakefile) for an example.
 
 
 Command Line Utility
 ====================
 
-The BitBalloon gem comes with a handy command line utility for deploying and redeploying sites.
+The BitBalloon gem comes with a handy command line utility for deploying and redeploying sites. (See the "Deploys" section below to deploy within a ruby script, like a Rakefile.)
 
 To deploy the site in the current working directory:
 
@@ -94,22 +106,26 @@ Getting a list of all sites you have access to:
 
 ```ruby
 bitballoon.sites.each do |site|
+  puts site.id
   puts site.url
 end
 ```
 
-Getting a specific site by id:
+Each site has a unique, system generated id. Getting a specific site by id:
 
 ```ruby
 site = bitballoon.sites.get(id)
 ```
 
-Creating a site from a directory:
+Creating a site from a directory: _(note the path given is a system path)_
 
 ```ruby
-site = bitballoon.sites.create(:dir => "/tmp/my-site")
+site = bitballoon.sites.create(:dir => "my-site")
+puts site.id
 ```
 
+You'll want to then save that site id for future reference. Note that a site can also be looked up by its `url`.
+
 Creating a site from a zip file:
 
 ```ruby
@@ -129,7 +145,7 @@ Refresh a site to update the state:
     site.refresh
 ```
 
-Use `wait_until_ready` to wait until a site has finished processing.
+Use `wait_for_ready` to wait until a site has finished processing.
 
 ```ruby
 site = bitballoon.sites.create(:dir => "/tmp/my-site")

data/bin/bitballoon

@@ -43,6 +43,8 @@ opts = Slop.parse do
 
       attributes = zip ? {:zip => path} : {:dir => path}
 
+      puts "Deploying site"
+
       if credentials['site_id']
         site = client.sites.get(credentials['site_id'])
         site.update(attributes)

data/lib/bitballoon/client.rb

@@ -12,13 +12,14 @@ module BitBalloon
     class InternalServerError < BitBalloonError; end
     class AuthenticationError < BitBalloonError; end
 
-    attr_accessor :client_id, :client_secret, :oauth, :access_token
+    attr_accessor :client_id, :client_secret, :oauth, :access_token, :endpoint
 
     def initialize(options)
       self.client_id     = options[:client_id]
       self.client_secret = options[:client_secret]
       self.access_token  = options[:access_token]
-      self.oauth         = OAuth2::Client.new(client_id, client_secret, :site => ENDPOINT, :connection_build => lambda {|f|
+      self.endpoint      = options[:endpoint] || ENDPOINT
+      self.oauth         = OAuth2::Client.new(client_id, client_secret, :site => endpoint, :connection_build => lambda {|f|
         f.request :multipart
         f.request :url_encoded
         f.adapter :net_http
@@ -109,4 +110,4 @@ module BitBalloon
       error.message.strip == "" ? default : error.message
     end
   end
-end
+end

data/lib/bitballoon/deploy.rb

@@ -5,7 +5,7 @@ module BitBalloon
            :user_id, :required
 
     def restore
-      response = client.request(:post, File.join(path, "restore"))
+      response = client.request(:post, ::File.join(path, "restore"))
       process(response.parsed)
       self
     end

data/lib/bitballoon/multipass.rb

@@ -9,7 +9,7 @@ module BitBalloon
     def initialize(multipass_secret)
       ### Use the Multipass secret to derive two cryptographic keys,
       ### one for encryption, one for signing
-      key_material = OpenSSL::Digest::Digest.new("sha256").digest(multipass_secret)
+      key_material = OpenSSL::Digest.new("sha256").digest(multipass_secret)
       @encryption_key = key_material[ 0,16]
       @signature_key  = key_material[16,16]
     end
@@ -67,4 +67,4 @@ module BitBalloon
       OpenSSL::HMAC.digest("sha256", @signature_key, data)
     end
   end
-end
+end

data/lib/bitballoon/site.rb

@@ -11,7 +11,9 @@ module BitBalloon
       return unless state == "uploading"
 
       shas = Hash.new { [] }
-      Dir[::File.join(dir, "**", "*")].each do |file|
+      glob = ::File.join(dir, "**", "*")
+
+      Dir.glob(glob) do |file|
         next unless ::File.file?(file)
         pathname = ::File.join("/", file[dir.length..-1])
         next if pathname.match(/(^\/?__MACOSX\/|\/\.)/)
@@ -22,7 +24,6 @@ module BitBalloon
 
       (required || []).each do |sha|
         shas[sha].each do |pathname|
-          puts "Uploading #{pathname}"
           client.request(:put, ::File.join(path, "files", URI.encode(pathname)), :body => ::File.read(::File.join(dir, pathname)), :headers => {"Content-Type" => "application/octet-stream"})
         end
       end
@@ -95,4 +96,4 @@ module BitBalloon
       }.compact.flatten]
     end
   end
-end
+end

data/lib/bitballoon/version.rb

@@ -1,3 +1,3 @@
 module BitBalloon
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
 end

data/test/client_test.rb

@@ -8,8 +8,12 @@ class ClientTest < MiniTest::Unit::TestCase
   end
 
   def test_authorize_url
-    expected = "https://www.bitballoon.com/oauth/authorize?response_type=code&client_id=client_id&redirect_uri=http%3A%2F%2Fexample.com%2Fcallback"
-    assert_equal expected, client.authorize_url(:redirect_uri => "http://example.com/callback")
+    expected = URI.parse("https://www.bitballoon.com/oauth/authorize?response_type=code&client_id=client_id&redirect_uri=http%3A%2F%2Fexample.com%2Fcallback")
+    actual   = URI.parse(client.authorize_url(:redirect_uri => "http://example.com/callback"))
+    assert_equal expected.scheme, actual.scheme
+    assert_equal expected.host,   actual.host
+    assert_equal expected.port,   actual.port
+    assert_equal expected.query.split("&").sort, actual.query.split("&").sort
   end
 
   def test_authorize_from_code
@@ -70,4 +74,4 @@ class ClientTest < MiniTest::Unit::TestCase
     site = client.sites.get("1234")
     assert_equal "http://www.example.com", site.url
   end
-end
+end

metadata

@@ -1,94 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: bitballoon
 version: !ruby/object:Gem::Version
-  version: 0.1.3
-  prerelease: 
+  version: 0.1.5
 platform: ruby
 authors:
 - Mathias Biilmann Christensen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-21 00:00:00.000000000 Z
+date: 2014-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: API Client for BitBalloon
@@ -140,27 +129,26 @@ files:
 - test/test_helper.rb
 homepage: https://www.bitballoon.com
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: API Client for BitBalloon
 test_files:
 - test/client_test.rb
@@ -169,4 +157,3 @@ test_files:
 - test/multipass_test.rb
 - test/sites_test.rb
 - test/test_helper.rb
-has_rdoc: