packagecloud-ruby 0.2.17 → 0.2.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e8f650dbc96aa88992fc0dda27623c8719d18c7
-  data.tar.gz: ef502f707b27a9a07f2530fb8e2deb41c3bc00f7
+  metadata.gz: 7d5b9cfbb4fa58fd4513b51b77128a5f79b09cec
+  data.tar.gz: 79c30b70c7404f03a2162def26a4c7de879e5ba0
 SHA512:
-  metadata.gz: d02c15ff34c1d54263bb1fc52acddb1a05f09694eb175076e218e35f5051410b4939f48f20adf5748cd3266f38dbc1369764994ec168514288e8674950ef902b
-  data.tar.gz: 4eafaf179abc1380cf65756f3a2b1ac853c3f4d2d497ba42be3109405fba18d82015bf01fc18e1fb9f667a8a624656a49a5e086ea3ee1dd1ca1322e447615f36
+  metadata.gz: ed77f5de56f89489e43296cfbf581bcb9abb713d4020403494a5db9f4931b01e96d7650b14ebb44bdafb7c9ff4051f7b659694a55905c7dfbf07a6da7dfc433a
+  data.tar.gz: 759d2175cb37074adf17231af1cfd198f6af203420a57fcdb25771a894e39d2073dff0dbc0a295366354c4a71c2c187305d24b3ea5bb6a51066695491256359c

data/README.md

@@ -22,13 +22,22 @@ Ruby library for communicating with the [packagecloud.io](https://packagecloud.i
   gem install packagecloud-ruby
   ```
 
+## Getting your API token
+
+Login to [packagecloud.io](https://packagecloud.io) and
+go to your [Account Settings](https://packagecloud.io/api_token) to see your API token.
+
 ## Creating a Client
 
+  Note that you should not use the email address associated with your
+  [packagecloud.io](https://packagecloud.io) account when accessing the API.
+  Please use your username on the site.
+
   ```ruby
   require 'packagecloud'
 
-  # Create a client
-  credentials = Packagecloud::Credentials.new("joedamato", "test_token")
+  # Create a client using your username and API token
+  credentials = Packagecloud::Credentials.new("joedamato", "my_api_token")
   @client = Packagecloud::Client.new(credentials)
 
   ```
@@ -54,12 +63,14 @@ Ruby library for communicating with the [packagecloud.io](https://packagecloud.i
 
 ### Distributions
 
+  This is the list of currently [supported distributions](https://packagecloud.io/docs#os_distro_version).
+
   ```ruby
   # Get all distributions
   distros = @client.distributions
 
   # Looking up a distribution id by name
-  id = @client.find_distribution_id("centos/6") # returns 12
+  id = @client.find_distribution_id("el/6") # returns 27
   ```
 
 ### Repositories
@@ -76,17 +87,31 @@ Ruby library for communicating with the [packagecloud.io](https://packagecloud.i
 
   ```
 
+  When specifiying your repository name, you should use just the name and not
+  the fully qualified name (fqname).
+
+  For example:
+
+  ```ruby
+  # INCORRECT: this should just be "my_repo"
+  repo = @client.repository("user/my_repo")
+  ```
+
 ### Packages
 
   ```ruby
-  # Create Packages (takes IO object for file)
-  gem_package = Package.new(open("rails-4.0.0.gem"))
-  rpm_package = Package.new(open("libcurl-0.1.2.rpm"), 12) # 12 being the distribution id for centos/6, for example
+  # Create RPM Packages (takes IO object for file)
+  distro_id = @client.find_distribution_id("el/6")
+  rpm_package = Packagecloud::Package.new(open("libcurl-0.1.2.rpm"), distro_id)
+
+  # Creating gem Packages (no distribution required)
+  gem_package = Packagecloud::Package.new(open("rails-4.0.0.gem"))
 
   # Creating source Packages
+  distro_id = @client.find_distribution_id("ubuntu/trusty")
   source_files = { "jake_1.0.orig.tar.bz2" => open("/path/jake_1.0.orig.tar.bz2"),
                    "jake_1.0-7.debian.tar.gz" => open("/path/jake_1.0-7.debian.tar.gz") }
-  dsc_package = Package.new("jake_1.0-7.dsc", 20, source_files)
+  dsc_package = Packagecloud::Package.new("jake_1.0-7.dsc", distro_id, source_files)
 
   # Upload Packages
   @client.put_package("test_repo", gem_package)
@@ -96,6 +121,6 @@ Ruby library for communicating with the [packagecloud.io](https://packagecloud.i
 
 ## Copyright
 
-Copyright (c) 2014 Computology, LLC
+Copyright (c) 2014-2015 Computology, LLC
 
 See LICENSE.txt for details.

data/lib/packagecloud/client.rb

@@ -24,6 +24,22 @@ module Packagecloud
     end
   end
 
+  class InvalidRepoNameException < StandardError
+    attr_reader :object
+
+    def initialize(object = nil)
+      @object = object
+    end
+  end
+
+  class InvalidUsernameException < StandardError
+    attr_reader :object
+
+    def initialize(object = nil)
+      @object = object
+    end
+  end
+
   class Client
     attr_reader :connection
     attr_reader :credentials
@@ -54,6 +70,7 @@ module Packagecloud
     end
 
     def repository(repo)
+      assert_valid_repo_name(repo)
       response = get("/api/v1/repos/#{username}/#{repo}.json")
       parsed_json_result(response)
     end
@@ -64,6 +81,7 @@ module Packagecloud
     end
 
     def create_repository(repo, private=false)
+      assert_valid_repo_name(repo)
       privacy = private ? 1 : 0
       body = { "repository" => { "name" => repo, "private" => privacy.to_s } }
       response = post("/api/v1/repos.json", body.to_json)
@@ -71,6 +89,7 @@ module Packagecloud
     end
 
     def package_contents(repo, package)
+      assert_valid_repo_name(repo)
       url = "/api/v1/repos/#{username}/#{repo}/packages/contents.json"
 
       mixed_msg = MIME::Multipart::FormData.new
@@ -85,6 +104,8 @@ module Packagecloud
     end
 
     def put_package(repo, package)
+      assert_valid_repo_name(repo)
+
       url = "/api/v1/repos/#{username}/#{repo}/packages.json"
 
       mixed_msg = MIME::Multipart::FormData.new
@@ -127,6 +148,15 @@ module Packagecloud
     end
 
     private
+      def assert_valid_repo_name(repo)
+        if repo.include?("/")
+          raise InvalidRepoNameException.new("The repo name: #{repo} is " \
+                                             "invalid. It looks like you are " \
+                                             "using the fully qualified name " \
+                                             "(fqname) instead of just the " \
+                                             "repo name. Please try again.")
+        end
+      end
 
       def assert_compatible_version
         result = gem_version
@@ -216,4 +246,4 @@ module Packagecloud
       end
 
   end
-end
+end

data/lib/packagecloud/credentials.rb

@@ -6,6 +6,13 @@ module Packagecloud
     def initialize(username, token)
       @username = username
       @token = token
+      if @username.include?("@")
+        raise InvalidUsernameException.new("Sorry, looks like you may have " \
+                                           "tried to use an email address " \
+                                           "instead of your packagecloud.io " \
+                                           "username. Please use your " \
+                                           "username instead!")
+      end
     end
   end
-end
+end

data/lib/packagecloud/version.rb

@@ -1,7 +1,7 @@
 module Packagecloud
   MAJOR_VERSION = "0"
   MINOR_VERSION = "2"
-  PATCH_VERSION = "17"
+  PATCH_VERSION = "19"
 
   VERSION = [MAJOR_VERSION, MINOR_VERSION, PATCH_VERSION].join(".")
 end

data/spec/packagecloud_spec.rb

@@ -133,6 +133,12 @@ describe Packagecloud do
     expect(result.response["name"]).to eq("test_repo")
   end
 
+  it "should raise if the repo name is invalid" do
+    expect do
+      result = @client.repository("hi/test_repo")
+    end.to raise_error(InvalidRepoNameException)
+  end
+
   it "GET /api/v1/repos/joedamato/invalid_repo.json (invalid repo)" do
     result = @client.repository("invalid_repo")
     expect(result.succeeded).to be_falsey
@@ -143,6 +149,12 @@ describe Packagecloud do
     expect($request["User-Agent"]).to eq("packagecloud-ruby #{Packagecloud::VERSION}/test_client")
   end
 
+  it "should raise if the username has an @ in it" do
+    expect do
+      credentials = Credentials.new("hi@test.com", "test_token")
+    end.to raise_error(InvalidUsernameException)
+  end
+
   it "should raise if api has advanced too far" do
     current = Packagecloud::MINOR_VERSION
     Packagecloud::MINOR_VERSION = "1"
@@ -177,7 +189,6 @@ describe Packagecloud do
   end
 
   describe "find_distribution_id" do
-
     it "should find ubuntu/breezy" do
       id = @client.find_distribution_id("ubuntu/breezy")
       expect(id).to be(3)
@@ -199,6 +210,4 @@ describe Packagecloud do
       }.to raise_error
     end
   end
-
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packagecloud-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.17
+  version: 0.2.19
 platform: ruby
 authors:
 - Joe Damato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-02 00:00:00.000000000 Z
+date: 2015-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -186,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: library for interacting with packagecloud.io