noun-project-api 0.2.2 → 3.1.0

data/spec/lib/noun_project_api/collection_spec.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "ostruct"
+
+RSpec.describe NounProjectApi::CollectionRetriever do
+  it "raises an error on empty initialization input" do
+    expect { NounProjectApi::Collection.new }.to raise_error(ArgumentError)
+  end
+
+  it "accepts JSON string input" do
+    data = JSON.parse(Fakes::Results::COLLECTION_VALID)
+    expect { NounProjectApi::Collection.new(JSON.dump(data["collection"])) }.to_not raise_error
+  end
+
+  it "accepts JSON string input with collection encapsulation" do
+    expect { NounProjectApi::Collection.new(Fakes::Results::COLLECTION_VALID) }.to_not raise_error
+  end
+
+  it "accepts hash input" do
+    data = JSON.parse(Fakes::Results::COLLECTION_VALID)
+    expect { NounProjectApi::Collection.new(data) }.to_not raise_error
+  end
+
+  context "exposed attributes" do
+    before :each do
+      @json = JSON.parse(Fakes::Results::COLLECTION_VALID)
+      @valid_collection = NounProjectApi::Collection.new(Fakes::Results::COLLECTION_VALID)
+    end
+
+    it "id as number" do
+      expect(@valid_collection.id).to be_a(Integer)
+      expect(@valid_collection.id).to eq(@json["collection"]["id"].to_i)
+    end
+
+    it "author id as number" do
+      expect(@valid_collection.author_id).to eq(@json["collection"]["author_id"].to_i)
+    end
+
+    it "author name" do
+      expect(@valid_collection.author_name).to eq(@json["collection"]["author"]["name"])
+    end
+
+    it "icon count as number" do
+      expect(@valid_collection.icon_count).to eq(@json["collection"]["icon_count"].to_i)
+    end
+
+    it "is published" do
+      expect(@valid_collection.published?).to eq(@json["collection"]["is_published"].to_i == 1)
+    end
+
+    it "builds a simple hash" do
+      expect(@valid_collection.to_hash).to eq(
+        id: @valid_collection.id,
+        author_id: @valid_collection.author_id,
+        author_name: @valid_collection.author_name,
+        icon_count: @valid_collection.icon_count,
+        published: @valid_collection.published?
+      )
+    end
+
+    it "json formats the hash" do
+      expect(@valid_collection.to_json).to eq JSON.dump @valid_collection.to_hash
+    end
+  end
+end

data/spec/lib/{noun-project-api → noun_project_api}/icon_retriever_spec.rb

@@ -1,26 +1,28 @@
-require 'spec_helper'
-require 'ostruct'
+# frozen_string_literal: true
+
+require "spec_helper"
+require "ostruct"
 
 RSpec.describe NounProjectApi::IconRetriever do
   before :each do
-    @icon = NounProjectApi::IconRetriever.new(Faker::Internet.password(16), Faker::Internet.password(16))
-    @valid_hash = JSON.parse(Fakes::Results::ICON_VALID)
+    @icon = NounProjectApi::IconRetriever.new(Faker::Internet.password(min_length: 16), Faker::Internet.password(min_length: 16))
+    @valid_hash = JSON.parse(Fakes::Results::ICON_VALID, symbolize_names: true)
     @valid_response = OpenStruct.new(
       body: Fakes::Results::ICON_VALID,
-      code: '200'
+      code: "200"
     )
 
     @missing_response = OpenStruct.new(
-      code: '404'
+      code: "404"
     )
   end
 
   context "id" do
-    it 'raises an error when no id is provided' do
+    it "raises an error when no id is provided" do
       expect { @icon.find(nil) }.to raise_error(ArgumentError)
     end
 
-    it 'returns a proper result with a correct id' do
+    it "returns a proper result with a correct id" do
       id = 1
       expect(@icon.access_token).to receive(
         :get
@@ -32,10 +34,10 @@ RSpec.describe NounProjectApi::IconRetriever do
 
       result = @icon.find(id)
       expect(result).to be_a(NounProjectApi::Icon)
-      expect(result.original_hash).to eq(@valid_hash["icon"])
+      expect(result.original_hash).to eq(@valid_hash[:icon])
     end
 
-    it 'raises an error with a missing id' do
+    it "raises an error with a missing id" do
       id = 1
       expect(@icon.access_token).to receive(
         :get
@@ -45,17 +47,17 @@ RSpec.describe NounProjectApi::IconRetriever do
         @missing_response
       )
 
-      expect { @icon.find(id) }.to raise_error(ArgumentError)
+      expect { @icon.find(id) }.to raise_error(NounProjectApi::ServiceError)
     end
   end
 
   context "slug" do
-    it 'raises an error when no slug is provided' do
+    it "raises an error when no slug is provided" do
       expect { @icon.find_by_slug(nil) }.to raise_error(ArgumentError)
     end
 
-    it 'returns a proper result with a correct slug' do
-      slug = 'existing_slug'
+    it "returns a proper result with a correct slug" do
+      slug = "existing_slug"
       expect(@icon.access_token).to receive(
         :get
       ).with(
@@ -66,11 +68,11 @@ RSpec.describe NounProjectApi::IconRetriever do
 
       result = @icon.find(slug)
       expect(result).to be_a(NounProjectApi::Icon)
-      expect(result.original_hash).to eq(@valid_hash["icon"])
+      expect(result.original_hash).to eq(@valid_hash[:icon])
     end
 
-    it 'raises an error with a missing slug' do
-      slug = 'missing_slug'
+    it "raises an error with a missing slug" do
+      slug = "missing_slug"
       expect(@icon.access_token).to receive(
         :get
       ).with(
@@ -79,7 +81,7 @@ RSpec.describe NounProjectApi::IconRetriever do
         @missing_response
       )
 
-      expect { @icon.find_by_slug(slug) }.to raise_error(ArgumentError)
+      expect { @icon.find_by_slug(slug) }.to raise_error(NounProjectApi::ServiceError)
     end
   end
 end

data/spec/lib/{noun-project-api → noun_project_api}/icon_spec.rb

@@ -1,21 +1,23 @@
-require 'spec_helper'
-require 'ostruct'
+# frozen_string_literal: true
+
+require "spec_helper"
+require "ostruct"
 
 RSpec.describe NounProjectApi::IconRetriever do
-  it 'raises an error on empty initialization input' do
+  it "raises an error on empty initialization input" do
     expect { NounProjectApi::Icon.new }.to raise_error(ArgumentError)
   end
 
-  it 'accepts JSON string input' do
+  it "accepts JSON string input" do
     data = JSON.parse(Fakes::Results::ICON_VALID)
     expect { NounProjectApi::Icon.new(JSON.dump(data["icon"])) }.to_not raise_error
   end
 
-  it 'accepts JSON string input with icon encapsulation' do
+  it "accepts JSON string input with icon encapsulation" do
     expect { NounProjectApi::Icon.new(Fakes::Results::ICON_VALID) }.to_not raise_error
   end
 
-  it 'accepts hash input' do
+  it "accepts hash input" do
     data = JSON.parse(Fakes::Results::ICON_VALID)
     expect { NounProjectApi::Icon.new(data) }.to_not raise_error
   end
@@ -26,51 +28,51 @@ RSpec.describe NounProjectApi::IconRetriever do
       @valid_icon = NounProjectApi::Icon.new(Fakes::Results::ICON_VALID)
     end
 
-    it 'public domain' do
+    it "public domain" do
       expect(@valid_icon.public_domain?).to eq(@json["icon"]["license_description"] == "public-domain")
     end
 
-    it 'SVG url' do
+    it "SVG url" do
       expect(@valid_icon.svg_url).to eq(@json["icon"]["icon_url"])
     end
 
-    it 'nil on missing SVG url' do
+    it "nil on missing SVG url" do
       @json["icon"].delete("icon_url")
       icon = NounProjectApi::Icon.new(@json)
       expect(icon.svg_url).to be_nil
     end
 
-    it 'preview url defaults at 200 size' do
+    it "preview url defaults at 200 size" do
       expect(@valid_icon.preview_url).to eq(@json["icon"]["preview_url"])
     end
 
-    it 'preview url for 200 size' do
+    it "preview url for 200 size" do
       expect(@valid_icon.preview_url(NounProjectApi::Icon::PREVIEW_SIZE_200)).to eq(@json["icon"]["preview_url"])
     end
 
-    it 'preview url for 84 size' do
+    it "preview url for 84 size" do
       expect(@valid_icon.preview_url(NounProjectApi::Icon::PREVIEW_SIZE_84)).to eq(@json["icon"]["preview_url_84"])
     end
 
-    it 'preview url for 42 size' do
+    it "preview url for 42 size" do
       expect(@valid_icon.preview_url(NounProjectApi::Icon::PREVIEW_SIZE_42)).to eq(@json["icon"]["preview_url_42"])
     end
 
-    it 'id as number' do
-      expect(@valid_icon.id).to be_a(Fixnum)
+    it "id as number" do
+      expect(@valid_icon.id).to be_a(Integer)
       expect(@valid_icon.id).to eq(@json["icon"]["id"].to_i)
     end
 
-    it 'builds a simple hash' do
-      expect(@valid_icon.to_hash).to eq({
+    it "builds a simple hash" do
+      expect(@valid_icon.to_hash).to eq(
         id: @valid_icon.id,
         preview_url_200: @valid_icon.preview_url(NounProjectApi::Icon::PREVIEW_SIZE_200),
         preview_url_84: @valid_icon.preview_url(NounProjectApi::Icon::PREVIEW_SIZE_84),
         preview_url_42: @valid_icon.preview_url(NounProjectApi::Icon::PREVIEW_SIZE_42)
-      })
+      )
     end
 
-    it 'json formats the hash' do
+    it "json formats the hash" do
       expect(@valid_icon.to_json).to eq JSON.dump @valid_icon.to_hash
     end
   end

data/spec/lib/{noun-project-api → noun_project_api}/icons_retriever_spec.rb

@@ -1,8 +1,10 @@
-require 'spec_helper'
+# frozen_string_literal: true
+
+require "spec_helper"
 
 RSpec.describe NounProjectApi::IconsRetriever do
   before :each do
-    @icons = NounProjectApi::IconsRetriever.new(Faker::Internet.password(16), Faker::Internet.password(16))
+    @icons = NounProjectApi::IconsRetriever.new(Faker::Internet.password(min_length: 16), Faker::Internet.password(min_length: 16))
   end
 
   context "recent uploads" do
@@ -10,7 +12,7 @@ RSpec.describe NounProjectApi::IconsRetriever do
       valid_hash = JSON.parse(Fakes::Results::ICONS_RECENT_VALID)
       valid_response = OpenStruct.new(
         body: Fakes::Results::ICONS_RECENT_VALID,
-        code: '200'
+        code: "200"
       )
 
       expect(@icons.access_token).to receive(
@@ -31,7 +33,7 @@ RSpec.describe NounProjectApi::IconsRetriever do
     it "returns the recent uploads and passes limit when passed" do
       valid_response = OpenStruct.new(
         body: Fakes::Results::ICONS_RECENT_VALID,
-        code: '200'
+        code: "200"
       )
 
       limit = 3
@@ -53,22 +55,22 @@ RSpec.describe NounProjectApi::IconsRetriever do
   end
 
   context "Icons search" do
-    it 'raises an error when no phrase is provided' do
+    it "raises an error when no phrase is provided" do
       expect { @icons.find(nil) }.to raise_error(ArgumentError)
     end
 
-    it 'properly URI encodes search patterns' do
+    it "properly URI encodes search patterns" do
       valid_hash = JSON.parse(Fakes::Results::ICONS_VALID)
       valid_response = OpenStruct.new(
         body: Fakes::Results::ICONS_VALID,
-        code: '200'
+        code: "200"
       )
 
-      term = 'some search with \',] bad chars'
+      term = 'some search with ",] bad chars'
       expect(@icons.access_token).to receive(
         :get
       ).with(
-        "#{NounProjectApi::API_BASE}#{NounProjectApi::IconsRetriever::API_PATH}#{OAuth::Helper::escape(term)}?limit_to_public_domain=0"
+        "#{NounProjectApi::API_BASE}#{NounProjectApi::IconsRetriever::API_PATH}#{OAuth::Helper.escape(term)}?limit_to_public_domain=0"
       ).and_return(
         valid_response
       )
@@ -80,18 +82,18 @@ RSpec.describe NounProjectApi::IconsRetriever do
       end
     end
 
-    it 'returns a proper result with a correct phrase' do
+    it "returns a proper result with a correct phrase" do
       valid_hash = JSON.parse(Fakes::Results::ICONS_VALID)
       valid_response = OpenStruct.new(
         body: Fakes::Results::ICONS_VALID,
-        code: '200'
+        code: "200"
       )
 
-      term = 'some search'
+      term = "some search"
       expect(@icons.access_token).to receive(
         :get
       ).with(
-        "#{NounProjectApi::API_BASE}#{NounProjectApi::IconsRetriever::API_PATH}#{OAuth::Helper::escape(term)}?limit_to_public_domain=0"
+        "#{NounProjectApi::API_BASE}#{NounProjectApi::IconsRetriever::API_PATH}#{OAuth::Helper.escape(term)}?limit_to_public_domain=0"
       ).and_return(
         valid_response
       )
@@ -103,18 +105,18 @@ RSpec.describe NounProjectApi::IconsRetriever do
       end
     end
 
-    it 'properly handles public domain only config' do
+    it "properly handles public domain only config" do
       valid_hash = JSON.parse(Fakes::Results::ICONS_VALID)
       valid_response = OpenStruct.new(
         body: Fakes::Results::ICONS_VALID,
-        code: '200'
+        code: "200"
       )
 
-      term = 'some search'
+      term = "some search"
       expect(@icons.access_token).to receive(
         :get
       ).with(
-        "#{NounProjectApi::API_BASE}#{NounProjectApi::IconsRetriever::API_PATH}#{OAuth::Helper::escape(term)}?limit_to_public_domain=1"
+        "#{NounProjectApi::API_BASE}#{NounProjectApi::IconsRetriever::API_PATH}#{OAuth::Helper.escape(term)}?limit_to_public_domain=1"
       ).and_return(
         valid_response
       )
@@ -128,18 +130,18 @@ RSpec.describe NounProjectApi::IconsRetriever do
       NounProjectApi.configuration.public_domain = false
     end
 
-    it 'returns a proper result with a correct phrase and passes along the args' do
+    it "returns a proper result with a correct phrase and passes the args" do
       valid_response = OpenStruct.new(
         body: Fakes::Results::ICONS_VALID,
-        code: '200'
+        code: "200"
       )
 
-      term = 'some search'
+      term = "some search"
       limit = 4
       expect(@icons.access_token).to receive(
         :get
       ).with(
-        "#{NounProjectApi::API_BASE}#{NounProjectApi::IconsRetriever::API_PATH}#{OAuth::Helper::escape(term)}?limit_to_public_domain=0&limit=#{limit}"
+        "#{NounProjectApi::API_BASE}#{NounProjectApi::IconsRetriever::API_PATH}#{OAuth::Helper.escape(term)}?limit_to_public_domain=0&limit=#{limit}"
       ).and_return(
         valid_response
       )
@@ -151,16 +153,16 @@ RSpec.describe NounProjectApi::IconsRetriever do
       end
     end
 
-    it 'returns an empty array for no result' do
+    it "returns an empty array for no result" do
       missing_response = OpenStruct.new(
-        code: '404'
+        code: "404"
       )
 
-      term = 'missing search'
+      term = "missing search"
       expect(@icons.access_token).to receive(
         :get
       ).with(
-        "#{NounProjectApi::API_BASE}#{NounProjectApi::IconsRetriever::API_PATH}#{OAuth::Helper::escape(term)}?limit_to_public_domain=0"
+        "#{NounProjectApi::API_BASE}#{NounProjectApi::IconsRetriever::API_PATH}#{OAuth::Helper.escape(term)}?limit_to_public_domain=0"
       ).and_return(
         missing_response
       )

data/spec/lib/{noun-project-api → noun_project_api}/reporter_spec.rb

@@ -1,34 +1,36 @@
-require 'spec_helper'
+# frozen_string_literal: true
+
+require "spec_helper"
 
 RSpec.describe NounProjectApi::Reporter do
-  it 'raises an error when initialized without token' do
-    expect { NounProjectApi::Reporter.new(nil, Faker::Internet.password(16)) }.to raise_error(ArgumentError)
+  it "raises an error when initialized without token" do
+    expect { NounProjectApi::Reporter.new(nil, Faker::Internet.password(min_length: 16)) }.to raise_error(ArgumentError)
   end
 
-  it 'raises an error when initialized without secret' do
-    expect { NounProjectApi::Reporter.new(Faker::Internet.password(16), nil) }.to raise_error(ArgumentError)
+  it "raises an error when initialized without secret" do
+    expect { NounProjectApi::Reporter.new(Faker::Internet.password(min_length: 16), nil) }.to raise_error(ArgumentError)
   end
 
-  it 'initializes the values properly' do
-    token = Faker::Internet.password(16)
-    secret = Faker::Internet.password(16)
+  it "initializes the values properly" do
+    token = Faker::Internet.password(min_length: 16)
+    secret = Faker::Internet.password(min_length: 16)
     reporter = NounProjectApi::Reporter.new(token, secret)
 
     expect(reporter.token).to eq(token)
     expect(reporter.secret).to eq(secret)
   end
 
-  context 'reports ids usage' do
+  context "reports ids usage" do
     before :each do
-      token = Faker::Internet.password(16)
-      secret = Faker::Internet.password(16)
+      token = Faker::Internet.password(min_length: 16)
+      secret = Faker::Internet.password(min_length: 16)
       @reporter = NounProjectApi::Reporter.new(token, secret)
     end
 
-    it 'reports a singular id' do
+    it "reports a singular id" do
       valid_response = OpenStruct.new(
         body: Fakes::Results::REPORTED_ONE,
-        code: '200'
+        code: "200"
       )
 
       id = 122
@@ -38,7 +40,7 @@ RSpec.describe NounProjectApi::Reporter do
       ).with(
         "#{NounProjectApi::API_BASE}#{NounProjectApi::Reporter::API_PATH}",
         { icons: id.to_s }.to_json,
-        { 'Accept' => 'application/json', 'Content-Type' => 'application/json' }
+        "Accept" => "application/json", "Content-Type" => "application/json"
       ).and_return(
         valid_response
       )
@@ -47,20 +49,20 @@ RSpec.describe NounProjectApi::Reporter do
       expect(result).to be true
     end
 
-    it 'reports a singular id for a string' do
+    it "reports a singular id for a string" do
       valid_response = OpenStruct.new(
         body: Fakes::Results::REPORTED_ONE,
-        code: '200'
+        code: "200"
       )
 
-      id = '122'
+      id = "122"
 
       expect(@reporter.access_token).to receive(
         :post
       ).with(
         "#{NounProjectApi::API_BASE}#{NounProjectApi::Reporter::API_PATH}",
         { icons: id }.to_json,
-        { 'Accept' => 'application/json', 'Content-Type' => 'application/json' }
+        "Accept" => "application/json", "Content-Type" => "application/json"
       ).and_return(
         valid_response
       )
@@ -69,12 +71,10 @@ RSpec.describe NounProjectApi::Reporter do
       expect(result).to be true
     end
 
-
-
-    it 'reports multiple ids' do
+    it "reports multiple ids" do
       valid_response = OpenStruct.new(
         body: Fakes::Results::REPORTED_ONE,
-        code: '200'
+        code: "200"
       )
 
       ids = [122, 4541, 342_11, 4352]
@@ -83,8 +83,8 @@ RSpec.describe NounProjectApi::Reporter do
         :post
       ).with(
         "#{NounProjectApi::API_BASE}#{NounProjectApi::Reporter::API_PATH}",
-        { icons: ids.join(',') }.to_json,
-        { 'Accept' => 'application/json', 'Content-Type' => 'application/json' }
+        { icons: ids.join(",") }.to_json,
+        "Accept" => "application/json", "Content-Type" => "application/json"
       ).and_return(
         valid_response
       )