pogoplug 0.2.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p286@pogoplug"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.16.13 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - "1.9.3"

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,123 @@
+PATH
+  remote: .
+  specs:
+    pogoplug (0.2.0)
+      pogoplug
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    atomic (1.1.12)
+    builder (3.2.2)
+    coderay (1.0.9)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    ffi (1.9.0)
+    formatador (0.2.4)
+    git (1.2.5)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    guard (1.8.2)
+      formatador (>= 0.2.4)
+      listen (>= 1.0.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-bundler (1.0.0)
+      bundler (~> 1.0)
+      guard (~> 1.1)
+    guard-test (1.0.0)
+      guard (>= 1.8)
+      test-unit (~> 2.2)
+    hashie (2.0.5)
+    highline (1.6.19)
+    httpauth (0.2.0)
+    i18n (0.6.4)
+    jeweler (1.8.6)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    listen (1.2.3)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    lumberjack (1.0.4)
+    method_source (0.8.2)
+    minitest (4.7.5)
+    multi_json (1.7.8)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rake (10.1.0)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.0)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.0)
+      ffi (>= 0.5.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    ruby_gntp (0.3.4)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.1.4)
+    shoulda-matchers (2.2.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    slop (3.4.6)
+    test-unit (2.5.5)
+    thor (0.18.1)
+    thread_safe (0.1.2)
+      atomic
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  guard
+  guard-bundler
+  guard-test
+  jeweler (~> 1.8.4)
+  pogoplug!
+  rake
+  rdoc (~> 3.12)
+  ruby_gntp
+  shoulda
+  simplecov

data/Guardfile

@@ -0,0 +1,16 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard :test do
+  watch(%r{^lib/(.+)\.rb$})     { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{^test/.+_test\.rb$})
+  watch('test/test_helper.rb')  { "test" }
+end
+
+notification :terminal_title
+notification :gntp

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Travis Truman
+
+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.rdoc

@@ -0,0 +1,61 @@
+= pogoplug
+
+A simple Ruby wrapper on the PogoPlug API - http://download.pogoplug.com/dev/web.html
+
+{<img src="https://travis-ci.org/trumant/pogoplug.png" />}[https://travis-ci.org/trumant/pogoplug]
+
+== Structured API Operations Supported
+
+* getVersion
+* loginUser
+* listDevices
+* listServices
+* listFiles
+* createFile
+* removeFile
+
+== Stream API Operations Supported
+
+* PUT - via PogoPlug::Client.create_file passing an IO
+* GET - via PogoPlug::Client.download
+
+== Examples
+
+=== Retrieve the first page of files and folders from the root of a device and service
+
+  client = PogoPlug::Client.new
+  client.login("some_user@example.com", "some_password")
+
+  devices = client.devices
+
+  fileListing = client.files(devices.first.id, devices.first.services.first.id)
+  fileListing.files
+
+=== Write a file to PogoPlug and then download it
+
+  client = PogoPlug::Client.new
+  client.login("some_user@example.com", "some_password")
+  devices = client.devices
+
+  parent_directory = client.files(devices.first.id, devices.first.services.first.id).files.select { |file| file.directory? }.first
+  file_to_create = PogoPlug::File.new(name: 'your_file_name.txt', type: File::Type::FILE, parent_id: parent_directory.id)
+
+  uploaded_file = client.create_file(devices.first.id, devices.first.services.first, file_to_create, File.open('your_file_name.txt', 'r'))
+
+  downloaded_file = client.download(devices.first.id, devices.first.services.first, uploaded_file)
+
+== Contributing to pogoplug
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 Travis Truman. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "pogoplug"
+  gem.homepage = "http://github.com/trumant/pogoplug"
+  gem.license = "MIT"
+  gem.summary = %Q{A Ruby wrapper around the PogoPlug API}
+  gem.description = %Q{}
+  gem.email = "trumant@gmail.com"
+  gem.authors = ["Travis Truman"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "pogoplug #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/pogoplug/api_version.rb

@@ -0,0 +1,10 @@
+module PogoPlug
+  class ApiVersion
+    attr_accessor :version, :build_date
+
+    def initialize(version, build_date)
+      @version = version
+      @build_date = build_date
+    end
+  end
+end

data/lib/pogoplug/authentication_error.rb

@@ -0,0 +1,4 @@
+module PogoPlug
+  class AuthenticationError < StandardError
+  end
+end

data/lib/pogoplug/client.rb

@@ -0,0 +1,117 @@
+require 'httparty'
+require 'json'
+require 'open-uri'
+
+module PogoPlug
+  class Client
+    include HTTParty
+    # debug_output $stdout
+    base_uri 'https://service.pogoplug.com/svc/api/json'
+    format :json
+    attr_accessor :token
+
+    # Retrieve the current version information of the service
+    def version
+      response = self.class.get('/getVersion')
+      json = JSON.parse(response.body)
+      ApiVersion.new(json['version'], json['builddate'])
+    end
+
+    # Retrieve an auth token that can be used to make additional calls
+    # * *Raises* :
+    #   - +AuthenticationError+ -> if PogoPlug does not like the credentials you provided
+    def login(email, password)
+      response = self.class.get('/loginUser', query: { email: email, password: password })
+      raise_errors(response)
+      @token = response.parsed_response["valtoken"]
+      return self
+    end
+
+    # Retrieve a list of devices that are registered with the PogoPlug account
+    def devices
+      validate_token
+      response = self.class.get('/listDevices', query: { valtoken: @token })
+      devices = []
+      response.parsed_response['devices'].each do |d|
+        devices << Device.from_json(d)
+      end
+      devices
+    end
+
+    # Retrieve a list of services
+    def services(device_id=nil, shared=false)
+      validate_token
+      params = { valtoken: @token, shared: shared }
+      params[:deviceid] = device_id unless device_id.nil?
+
+      response = self.class.get('/listServices', query: params)
+      services = []
+      response.parsed_response['services'].each do |s|
+        services << Service.from_json(s)
+      end
+      services
+    end
+
+    # Retrieve a list of files for a device and service
+    def files(device_id, service_id, offset=0)
+      params = { valtoken: @token, deviceid: device_id, serviceid: service_id, pageoffset: offset }
+      response = self.class.get('/listFiles', query: params)
+      FileListing.from_json(response.parsed_response)
+    end
+
+    def create_directory(device_id, service_id, directory_name, parent_id=nil)
+      create_file(device_id, service_id, File.new(name: directory_name, parent_id: parent_id, type: File::Type::DIRECTORY))
+    end
+
+    # Creates a file handle and optionally attach an io.
+    # The provided file argument is expected to contain at minimum
+    # a name, type and parent_id. If it has a mimetype that will be assumed to
+    # match the mimetype of the io.
+    def create_file(device_id, service, file, io=nil)
+      params = { valtoken: @token, deviceid: device_id, serviceid: service.id, filename: file.name, type: file.type }
+      params[:parentid] = file.parent_id unless file.parent_id.nil?
+      response = self.class.get('/createFile', query: params)
+      file_handle = File.from_json(response.parsed_response['file'])
+      if io
+        send_file(device_id, service, file_handle, io)
+        file_handle.size = io.size
+      end
+      file_handle
+    end
+
+    def download(device_id, service, file)
+      raise "Directories cannot be downloaded" unless file.file?
+      open(URI.escape("#{service.api_url}files/#{@token}/#{device_id}/#{service.id}/#{file.id}/dl/#{file.name}")).read
+    end
+
+    def delete(device_id, service_id, file)
+      params = { valtoken: @token, deviceid: device_id, serviceid: service_id, fileid: file.id }
+      response = self.class.get('/removeFile', query: params)
+      true unless response.code.to_s != '200'
+    end
+
+    private
+
+    def validate_token
+      if @token.nil?
+        raise AuthenticationError('Authentication token is missing. Call login first.')
+      end
+    end
+
+    def raise_errors(response)
+      if response.parsed_response['HB-EXCEPTION'] && response.parsed_response['HB-EXCEPTION']['ecode'] == 606
+        raise AuthenticationError
+      end
+    end
+
+    def send_file(device_id, service, file_handle, io)
+      parent = file_handle.id || 0
+      uri = URI.parse("#{service.api_url}files/#{@token}/#{device_id}/#{service.id}/#{parent}/#{file_handle.name}")
+      req = Net::HTTP::Put.new(uri.path)
+      req['Content-Length'] = io.size
+      req['Content-Type'] = file_handle.mimetype
+      req.body_stream = io
+      put_response = Net::HTTP.new(uri.host, uri.port).request(req)
+    end
+  end
+end

data/lib/pogoplug/device.rb

@@ -0,0 +1,19 @@
+module PogoPlug
+  class Device
+    include HashInitializer
+
+    attr_accessor :name, :id, :services
+
+    def services
+      @services ||= Array.new
+    end
+
+    def self.from_json(json)
+      device = Device.new(name: json['name'], id: json['deviceid'])
+      json['services'].each do |s|
+        device.services << Service.from_json(s)
+      end
+      device
+    end
+  end
+end

data/lib/pogoplug/file.rb

@@ -0,0 +1,37 @@
+module PogoPlug
+  class File
+    attr_accessor :name, :id, :type, :size, :mimetype, :parent_id
+
+    module Type
+      FILE = 0
+      DIRECTORY = 1
+      STREAM = 2
+      SYMBOLIC_LINK = 3
+    end
+
+    include HashInitializer
+
+    def directory?
+      @type == File::Type::DIRECTORY
+    end
+
+    def file?
+      @type == File::Type::FILE
+    end
+
+    def size
+      @size || 0
+    end
+
+    def self.from_json(json)
+      File.new(
+        name: json['name'],
+        id: json['fileid'],
+        type: json['type'].to_i,
+        mimetype: json['mimetype'],
+        parent_id: json['parentid'],
+        size: json['size'].to_i
+      )
+    end
+  end
+end

data/lib/pogoplug/file_listing.rb

@@ -0,0 +1,27 @@
+module PogoPlug
+  class FileListing
+    include HashInitializer
+
+    attr_accessor :size, :offset, :total_count, :files
+
+    def files
+      @files ||= Array.new
+    end
+
+    def empty?
+      @files.empty?
+    end
+
+    def self.from_json(json)
+      listing = FileListing.new(
+        size: json['count'].to_i,
+        offset: json['pageoffset'].to_i,
+        total_count: json['totalcount'].to_i
+      )
+      json['files'].each do |f|
+        listing.files << File.from_json(f)
+      end
+      listing
+    end
+  end
+end

data/lib/pogoplug/hash_initializer.rb

@@ -0,0 +1,9 @@
+module PogoPlug
+  module HashInitializer
+    def initialize(*h)
+      if h.length == 1 && h.first.kind_of?(Hash)
+        h.first.each { |k,v| send("#{k}=",v) }
+      end
+    end
+  end
+end

data/lib/pogoplug/service.rb

@@ -0,0 +1,11 @@
+module PogoPlug
+  class Service
+    include HashInitializer
+
+    attr_accessor :name, :id, :api_url
+
+    def self.from_json(json)
+      Service.new(name: json['name'], id: json['serviceid'], api_url: json['apiurl'])
+    end
+  end
+end

data/lib/pogoplug/version.rb

@@ -0,0 +1,3 @@
+module PogoPlug
+  VERSION = "0.0.1"
+end

data/lib/pogoplug.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+
+require 'pogoplug/version'
+require 'pogoplug/hash_initializer'
+require 'pogoplug/client'
+require 'pogoplug/device'
+require 'pogoplug/file'
+require 'pogoplug/file_listing'
+require 'pogoplug/service'
+require 'pogoplug/api_version'
+require 'pogoplug/authentication_error'
+
+module PogoPlug
+end

data/listDevices.json

@@ -0,0 +1,45 @@
+{
+  "devices": [
+    {
+      "deviceid": "XCLDGAAAHE5B5NKDKMUXJ52F9J",
+      "type": "xce:cloud",
+      "name": "Pogoplug Cloud",
+      "version": "LINUX GENERIC - 4.6.0.12",
+      "flags": "0",
+      "ownerid": "1a3edf8b7a987226ec0840f37bf35cc5",
+      "sku": {
+        "id": "36",
+        "oem": "Cloud Engines",
+        "name": "POGOCLOUD-MCLOUDFREE",
+        "username": "Pogoplug Cloud",
+        "terms": "0"
+      },
+      "provisionflags": "0",
+      "authorized": "1",
+      "plan": {
+        "duration": "-1",
+        "limit": "0",
+        "name": "POGOCLOUD-MCLOUDFREE",
+        "startdate": "1376079072110",
+        "type": "POGOCLOUD"
+      },
+      "services": [
+        {
+          "deviceid": "XCLDGAAAHE5B5NKDKMUXJ52F9J",
+          "serviceid": "XCLDGAAAHE5B5NKDKMUXJ52F9J",
+          "sclass": "1",
+          "type": "xce:plugfs:cloud",
+          "name": "Pogoplug Cloud",
+          "version": "4.6.0.12",
+          "online": "1",
+          "msgpending": "0",
+          "apiurl": "https://cl0c0.pogoplug.com/svc/api/",
+          "space": "5000000000/5000000000",
+          "flags": "0",
+          "onlan": "0",
+          "metaver": "0"
+        }
+      ]
+    }
+  ]
+}