pogoplug 0.2.0

data/listFiles.json

@@ -0,0 +1,111 @@
+{
+  "files": [
+    {
+      "fileid": "AnonCRwPRDGnAnaAnD1aHg",
+      "type": "1",
+      "name": "Folder One",
+      "parentid": "0",
+      "mimetype": "",
+      "size": "0",
+      "ctime": "1376082451582",
+      "mtime": "1376082451582",
+      "origtime": "1376082451582",
+      "xcstamp": "",
+      "tnstamp": "",
+      "mdstamp": "",
+      "streamtype": "full",
+      "thumbnail": "",
+      "preview": "",
+      "stream": "",
+      "livestream": "",
+      "flvstream": "",
+      "properties": {
+        "origin": ""
+      },
+      "metaver": "0",
+      "filename": "Folder One",
+      "mediatype": ""
+    },
+    {
+      "fileid": "WJ0I39hPZfSIgLYSes5u0w",
+      "type": "0",
+      "name": "bar.txt",
+      "parentid": "0",
+      "mimetype": "text/plain",
+      "size": "0",
+      "ctime": "1376082434000",
+      "mtime": "1376082434000",
+      "origtime": "1376082434000",
+      "xcstamp": "",
+      "tnstamp": "",
+      "mdstamp": "",
+      "streamtype": "full",
+      "thumbnail": "",
+      "preview": "",
+      "stream": "",
+      "livestream": "",
+      "flvstream": "",
+      "properties": {
+        "origin": ""
+      },
+      "metaver": "0",
+      "filename": "bar.txt",
+      "mediatype": "text"
+    },
+    {
+      "fileid": "fb1Ker1AetW8139ZhbPGDQ",
+      "type": "0",
+      "name": "foo.txt",
+      "parentid": "0",
+      "mimetype": "text/plain",
+      "size": "0",
+      "ctime": "1376082428000",
+      "mtime": "1376082428000",
+      "origtime": "1376082428000",
+      "xcstamp": "",
+      "tnstamp": "",
+      "mdstamp": "",
+      "streamtype": "full",
+      "thumbnail": "",
+      "preview": "",
+      "stream": "",
+      "livestream": "",
+      "flvstream": "",
+      "properties": {
+        "origin": ""
+      },
+      "metaver": "0",
+      "filename": "foo.txt",
+      "mediatype": "text"
+    },
+    {
+      "fileid": "nZaBs2cdLUKQOu_vvFxn2w",
+      "type": "1",
+      "name": "Folder Two",
+      "parentid": "0",
+      "mimetype": "",
+      "size": "0",
+      "ctime": "1376082458122",
+      "mtime": "1376082458122",
+      "origtime": "1376082458122",
+      "xcstamp": "",
+      "tnstamp": "",
+      "mdstamp": "",
+      "streamtype": "full",
+      "thumbnail": "",
+      "preview": "",
+      "stream": "",
+      "livestream": "",
+      "flvstream": "",
+      "properties": {
+        "origin": ""
+      },
+      "metaver": "0",
+      "filename": "Folder Two",
+      "mediatype": ""
+    }
+  ],
+  "pageoffset": "0",
+  "count": "4",
+  "totalcount": "4"
+}

data/pogoplug.gemspec

@@ -0,0 +1,99 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "pogoplug"
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Travis Truman"]
+  s.date = "2013-08-19"
+  s.description = ""
+  s.email = "trumant@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rvmrc",
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "Guardfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/pogoplug.rb",
+    "lib/pogoplug/api_version.rb",
+    "lib/pogoplug/authentication_error.rb",
+    "lib/pogoplug/client.rb",
+    "lib/pogoplug/device.rb",
+    "lib/pogoplug/file.rb",
+    "lib/pogoplug/file_listing.rb",
+    "lib/pogoplug/hash_initializer.rb",
+    "lib/pogoplug/service.rb",
+    "lib/pogoplug/version.rb",
+    "listDevices.json",
+    "listFiles.json",
+    "pogoplug.gemspec",
+    "test/pogoplug/client_test.rb",
+    "test/pogoplug/device_test.rb",
+    "test/pogoplug/file_listing_test.rb",
+    "test/pogoplug/file_test.rb",
+    "test/pogoplug/helper.rb",
+    "test/pogoplug/service_test.rb",
+    "test/test_file.txt"
+  ]
+  s.homepage = "http://github.com/trumant/pogoplug"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.23"
+  s.summary = "A Ruby wrapper around the PogoPlug API"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<pogoplug>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.3"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<guard>, [">= 0"])
+      s.add_development_dependency(%q<guard-bundler>, [">= 0"])
+      s.add_development_dependency(%q<guard-test>, [">= 0"])
+      s.add_development_dependency(%q<ruby_gntp>, [">= 0"])
+    else
+      s.add_dependency(%q<pogoplug>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.3"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<guard>, [">= 0"])
+      s.add_dependency(%q<guard-bundler>, [">= 0"])
+      s.add_dependency(%q<guard-test>, [">= 0"])
+      s.add_dependency(%q<ruby_gntp>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<pogoplug>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.3"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<guard>, [">= 0"])
+    s.add_dependency(%q<guard-bundler>, [">= 0"])
+    s.add_dependency(%q<guard-test>, [">= 0"])
+    s.add_dependency(%q<ruby_gntp>, [">= 0"])
+  end
+end
+

data/test/pogoplug/client_test.rb

@@ -0,0 +1,207 @@
+require_relative 'helper'
+module PogoPlug
+  class ClientTest < Test::Unit::TestCase
+    context "Client" do
+      setup do
+        @client = PogoPlug::Client.new
+        @username = "gem_test_user@mailinator.com"
+        @password = "p@ssw0rd"
+      end
+
+      context "#version" do
+        should "provide version info" do
+          version = @client.version
+          assert_not_nil version
+          assert(version.version.is_a?(String) && !version.version.empty?, "Version number is missing.")
+          assert(version.build_date.is_a?(String) && !version.build_date.empty?, "Build date is missing")
+        end
+      end
+
+      context "#login" do
+        should "provide a client instance with a token" do
+          logged_in_client = @client.login(@username, @password)
+          assert(logged_in_client.token.is_a?(String) && !logged_in_client.token.empty?, "Auth token is missing")
+        end
+
+        should "raise an AuthenticationError when invalid credentials are provided" do
+          assert_raise(PogoPlug::AuthenticationError, "AuthenticationError should have been raised") do
+            @client.login("bad_email_address@mailinator.com", "bad_password")
+          end
+        end
+      end
+
+      context "#devices" do
+        setup do
+          @client.login(@username, @password)
+        end
+
+        should "provide a list of PogoPlug devices belonging to the user" do
+          devices = @client.devices
+          assert_not_nil(devices, "Devices are missing")
+          first_device = devices.first
+          assert_kind_of(PogoPlug::Device, first_device, "Device model instances should be returned")
+          assert_false(first_device.services.empty?, "Device services should not be empty")
+        end
+      end
+
+      context "#services" do
+        setup do
+          @client.login(@username, @password)
+        end
+
+        should "provide a list of PogoPlug services available to the user" do
+          services = @client.services
+          assert_not_nil(services, "Services are missing")
+          assert_kind_of(Enumerable, services)
+        end
+      end
+
+      context "#files" do
+        setup do
+          @client.login(@username, @password)
+          @device = @client.devices.first
+        end
+
+        should "provide a list of files for a device and service" do
+          files = @client.files(@device.id, @device.services.first.id)
+          assert_not_nil(files, "Files are missing")
+          assert_kind_of(PogoPlug::FileListing, files)
+          assert_false(files.empty?, "Files are not expected to be empty")
+        end
+
+        should "provide a means of paging through the files in the listing" do
+          file_listing = @client.files(@device.id, @device.services.first.id)
+          # dependent on previous test runs for us to have more than one page of files in the listing
+          if file_listing.total_count > file_listing.size
+            second_page = @client.files(@device.id, @device.services.first.id, file_listing.offset + 1)
+            assert_equal(file_listing.offset + 1, second_page.offset, "Expecting the second page listing to have the correct offset")
+            assert_false(second_page.empty?, "Expecting the second page of files to have some files")
+          end
+        end
+      end
+
+      context "#create_directory" do
+        setup do
+          @client.login(@username, @password)
+          @device = @client.devices.first
+          @directory_name = "My Test Directory #{rand(1000).to_i}"
+          @child_directory_name = "My Test Child Directory #{rand(1000).to_i}"
+        end
+
+        should "create a directory under the root" do
+          directory = @client.create_directory(@device.id, @device.services.first, @directory_name)
+          assert_not_nil(directory, "Directory should have been created")
+          assert_equal(directory.name, @directory_name, "Directory should have the correct name")
+          assert_equal(directory.parent_id, "0", "Directory should be at the root")
+          assert_true(directory.directory?, "Directory should be a directory")
+        end
+
+        should "create a directory under the specified parent" do
+          parent_directory = @client.files(@device.id, @device.services.first.id).files.select { |file| file.directory? }.first
+          directory = @client.create_directory(@device.id, @device.services.first, @child_directory_name, parent_directory.id)
+          assert_not_nil(directory, "Directory should have been created")
+          assert_equal(directory.name, @child_directory_name, "Directory should have the correct name")
+          assert_equal(directory.parent_id, parent_directory.id, "Directory should be under the correct parent")
+          assert_true(directory.directory?, "Directory should be a directory")
+        end
+      end
+
+      context "#create_file" do
+        setup do
+          @client.login(@username, @password)
+          @device = @client.devices.first
+          @file_name = "My test file #{rand(1000).to_i}"
+          @parent_directory = @client.files(@device.id, @device.services.first.id).files.select { |file| file.directory? }.first
+          @file_to_create = File.new(name: @file_name, type: File::Type::FILE, parent_id: @parent_directory.id)
+        end
+
+        should "create a file handle" do
+          created_file = @client.create_file(@device.id, @device.services.first, @file_to_create)
+          assert_not_nil(created_file, "File should have been created")
+          assert_equal(@file_name, created_file.name)
+          assert_equal(@file_to_create.type, created_file.type)
+          assert_equal(@file_to_create.parent_id, created_file.parent_id)
+          assert_not_nil(created_file.id)
+        end
+
+        should "create a file handle and attach the bits" do
+          test_file = ::File.new(::File.expand_path('../../test_file.txt', __FILE__), 'rb')
+          @file_to_create.name = ::File.basename(test_file.path)
+          created_file = @client.create_file(@device.id, @device.services.first, @file_to_create, test_file)
+          assert_not_nil(created_file)
+          assert_equal(test_file.size, created_file.size)
+        end
+      end
+
+      context "#delete" do
+        setup do
+          @client.login(@username, @password)
+          @device = @client.devices.first
+        end
+
+        should "delete an empty directory" do
+          directory_name = "My test directory #{rand(1000).to_i}"
+          directory = @client.create_file(@device.id, @device.services.first, File.new(name: directory_name, type: File::Type::DIRECTORY))
+          created_directory = @client.files(@device.id, @device.services.first.id).files.select { |file| file.directory? && file.name == directory_name }.first
+
+          assert_not_nil(created_directory, "Test directory was not created")
+          assert_true(@client.delete(@device.id, @device.services.first.id, directory), "Test directory was not deleted")
+
+          deleted_directory = @client.files(@device.id, @device.services.first.id).files.select { |file| file.directory? && file.name == directory_name }.first
+          assert_nil(deleted_directory, "Test directory that was supposed to have been deleted is still returned")
+        end
+
+        should "delete a directory and its children" do
+          parent_directory_name = "My test directory #{rand(1000).to_i}"
+          parent_directory = @client.create_file(@device.id, @device.services.first, File.new(name: parent_directory_name, type: File::Type::DIRECTORY))
+
+          child_directory_name = "My test child directory"
+          child_directory = @client.create_file(@device.id, @device.services.first, File.new(name: child_directory_name, type: File::Type::DIRECTORY, parent_id: parent_directory.id))
+
+          assert_true(@client.delete(@device.id, @device.services.first.id, parent_directory), "Test directory was not deleted")
+
+          deleted_directory = @client.files(@device.id, @device.services.first.id).files.select { |file| file.directory? && file.name == parent_directory_name }.first
+          assert_nil(deleted_directory, "Test directory that was supposed to have been deleted is still returned")
+        end
+
+        should "delete a file" do
+          file_name = "My test file #{rand(1000).to_i}"
+          file_to_create = File.new(name: file_name, type: File::Type::FILE)
+
+          created_file = @client.create_file(@device.id, @device.services.first, file_to_create)
+          assert_true(@client.delete(@device.id, @device.services.first.id, created_file), "File was not deleted")
+        end
+      end
+
+      context "#copy" do
+      end
+
+      context "#download" do
+        setup do
+          @client.login(@username, @password)
+          @device = @client.devices.first
+          @service = @device.services.first
+          @fileListing = @client.files(@device.id, @service.id)
+        end
+
+        should "fetch the file specified" do
+          file_to_download = @fileListing.files.select { |f| f.file? }.first
+          if file_to_download
+            io = @client.download(@device.id, @service, file_to_download)
+            file = ::File.write(file_to_download.name, io, nil, mode: 'wb')
+            assert_equal(file_to_download.size, io.size, "File should be the same size as the descriptor said it would be")
+          end
+        end
+
+        should "refuse to download a directory" do
+          file_to_download = @fileListing.files.select { |f| f.directory? }.first
+          if file_to_download
+            assert_raise(RuntimeError, "Directories cannot be downloaded") do
+              @client.download(@device.id, @service, file_to_download)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/test/pogoplug/device_test.rb

@@ -0,0 +1,81 @@
+require_relative 'helper'
+
+module PogoPlug
+  class DeviceTest < Test::Unit::TestCase
+    context "Device" do
+      setup do
+        @name = "Pogoplug Cloud"
+        @id = "XCLDGAAAHE5B5NKDKMUXJ52F9J"
+        @device = Device.new(name: @name, id: @id)
+      end
+
+      should "provide a name" do
+        assert_equal(@name, @device.name)
+      end
+
+      should "provide an ID" do
+        assert_equal(@id, @device.id)
+      end
+
+      should "allow services to be added" do
+        service = Service.new(name: "some name", id: "some id")
+        @device.services << service
+        assert_equal(service, @device.services.first)
+      end
+
+      should "provide a collection of services" do
+        assert_kind_of(Enumerable, @device.services)
+      end
+
+      should "be able to build instances from JSON" do
+        json = %q{
+          {
+            "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"
+              }
+            ]
+          }
+        }
+        device = Device.from_json(JSON.parse(json))
+        assert_equal("Pogoplug Cloud", device.name)
+        assert_equal("XCLDGAAAHE5B5NKDKMUXJ52F9J", device.id)
+        assert_equal(1, device.services.size, "Expected 1 service")
+      end
+    end
+  end
+end

data/test/pogoplug/file_listing_test.rb

@@ -0,0 +1,143 @@
+require_relative 'helper'
+
+module PogoPlug
+  class FileListingTest < Test::Unit::TestCase
+    context "FileListing" do
+      setup do
+        @size = 2
+        @offset = 0
+        @file_listing = FileListing.new(size: @size, offset: @offset, total_count: @size)
+      end
+
+      should "provide the number of files in the listing" do
+        assert_equal(@size, @file_listing.size)
+      end
+
+      context "from_json" do
+        should "produce a FileListing instance when given JSON" do
+          json = %q{
+            {
+              "files": [
+                {
+                  "fileid": "AnonCRwPRDGnAnaAnD1aHg",
+                  "type": "1",
+                  "name": "Folder One",
+                  "parentid": "0",
+                  "mimetype": "",
+                  "size": "0",
+                  "ctime": "1376082451582",
+                  "mtime": "1376082451582",
+                  "origtime": "1376082451582",
+                  "xcstamp": "",
+                  "tnstamp": "",
+                  "mdstamp": "",
+                  "streamtype": "full",
+                  "thumbnail": "",
+                  "preview": "",
+                  "stream": "",
+                  "livestream": "",
+                  "flvstream": "",
+                  "properties": {
+                    "origin": ""
+                  },
+                  "metaver": "0",
+                  "filename": "Folder One",
+                  "mediatype": ""
+                },
+                {
+                  "fileid": "WJ0I39hPZfSIgLYSes5u0w",
+                  "type": "0",
+                  "name": "bar.txt",
+                  "parentid": "0",
+                  "mimetype": "text/plain",
+                  "size": "0",
+                  "ctime": "1376082434000",
+                  "mtime": "1376082434000",
+                  "origtime": "1376082434000",
+                  "xcstamp": "",
+                  "tnstamp": "",
+                  "mdstamp": "",
+                  "streamtype": "full",
+                  "thumbnail": "",
+                  "preview": "",
+                  "stream": "",
+                  "livestream": "",
+                  "flvstream": "",
+                  "properties": {
+                    "origin": ""
+                  },
+                  "metaver": "0",
+                  "filename": "bar.txt",
+                  "mediatype": "text"
+                },
+                {
+                  "fileid": "fb1Ker1AetW8139ZhbPGDQ",
+                  "type": "0",
+                  "name": "foo.txt",
+                  "parentid": "0",
+                  "mimetype": "text/plain",
+                  "size": "0",
+                  "ctime": "1376082428000",
+                  "mtime": "1376082428000",
+                  "origtime": "1376082428000",
+                  "xcstamp": "",
+                  "tnstamp": "",
+                  "mdstamp": "",
+                  "streamtype": "full",
+                  "thumbnail": "",
+                  "preview": "",
+                  "stream": "",
+                  "livestream": "",
+                  "flvstream": "",
+                  "properties": {
+                    "origin": ""
+                  },
+                  "metaver": "0",
+                  "filename": "foo.txt",
+                  "mediatype": "text"
+                },
+                {
+                  "fileid": "nZaBs2cdLUKQOu_vvFxn2w",
+                  "type": "1",
+                  "name": "Folder Two",
+                  "parentid": "0",
+                  "mimetype": "",
+                  "size": "0",
+                  "ctime": "1376082458122",
+                  "mtime": "1376082458122",
+                  "origtime": "1376082458122",
+                  "xcstamp": "",
+                  "tnstamp": "",
+                  "mdstamp": "",
+                  "streamtype": "full",
+                  "thumbnail": "",
+                  "preview": "",
+                  "stream": "",
+                  "livestream": "",
+                  "flvstream": "",
+                  "properties": {
+                    "origin": ""
+                  },
+                  "metaver": "0",
+                  "filename": "Folder Two",
+                  "mediatype": ""
+                }
+              ],
+              "pageoffset": "0",
+              "count": "4",
+              "totalcount": "4"
+            }
+          }
+          listing = FileListing.from_json(JSON::parse(json))
+          assert_equal(4, listing.size, "Size does not match")
+          assert_equal(0, listing.offset, "Offset does not match")
+          assert_equal(4, listing.total_count, "Total count does not match")
+          assert_not_nil(listing.files, "Files are missing")
+          assert_kind_of(Enumerable, listing.files)
+          assert_equal(4, listing.files.size, "Expected 4 files")
+          assert_false(listing.empty?)
+        end
+      end
+    end
+  end
+end