noun-project-api 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 619e990e330b1b4f052966c8451846e258765009
-  data.tar.gz: 4a0151db35041c2019ebb02e7c559c65adeeaea3
+  metadata.gz: 810e93f2a6007af38536ac99d6d297b8a84419df
+  data.tar.gz: f672c9976b6425ca47ac49046b86ed52b43dcbd7
 SHA512:
-  metadata.gz: 77ff6f20e725233243c6a880d4261fe95d1dd478c15c0cd3f54c5e9d90c3e8f8e28ff658c3cef1c3657e83e866b06f989779de0e5ae7631ddb3fc0a37863a2fa
-  data.tar.gz: 8ddebd880e73358891119d2aee21dd1fc363a7cf03bf2b62bb8a8cbb5f89ed7136c607cbac6d0c34e5140cb0aecc38e5919e722bee51e16352f6fc537cc1f6a6
+  metadata.gz: f825fc58d3e1a3a217433488f0c3e91fab753eb05c7241a410690a50af2968b8f0448d5c787d630fb9e86e76155d461c81a336727fbc9cb54dd14af895231a0b
+  data.tar.gz: 80c91604f12dc4df532f30347efa178abefe40b74962593e67773cf89bb2a11e138ac2a096e1930c8e0e1f1db37e6b1235abf91901e9c7de7ebc0ec151efe299

data/lib/noun-project-api.rb

@@ -1,5 +1,6 @@
+require 'noun-project-api/icon_retriever'
+require 'noun-project-api/icons_retriever'
 require 'noun-project-api/icon'
-require 'noun-project-api/icons'
 
 module NounProjectApi
 end

data/lib/noun-project-api/icon.rb

@@ -1,18 +1,38 @@
-require 'noun-project-api/retriever'
-
 module NounProjectApi
-  class Icon < Retriever
-    API_PATH = "/icon/"
+  class Icon
+    PREVIEW_SIZE_200 = 200
+    PREVIEW_SIZE_42 = 42
+    PREVIEW_SIZE_84 = 84
+
+    PUBLIC_DOMAIN_LICENSE = "public-domain"
 
-    def find(id)
-      raise ArgumentError.new('Missing id/slug') unless id
+    attr_accessor :original_hash
 
-      result = self.access_token.get("#{API_BASE}#{API_PATH}#{id}")
-      raise ArgumentError.new('Bad request') unless result.code == '200'
+    def initialize(origin)
+      origin = JSON.parse(origin) if origin.is_a? String
+      origin = origin.delete("icon") if origin.key? "icon"
 
-      JSON.parse(result.body)["icon"]
+      @original_hash = origin
     end
 
-    alias_method :find_by_slug, :find
+    def id
+      original_hash["id"].to_i
+    end
+
+    def public_domain?
+      original_hash["license_description"] == PUBLIC_DOMAIN_LICENSE
+    end
+
+    def svg_url
+      original_hash["icon_url"]
+    end
+
+    def preview_url(size = PREVIEW_SIZE_200)
+      if size == PREVIEW_SIZE_200
+        original_hash["preview_url"]
+      else
+        original_hash["preview_url_#{size}"]
+      end
+    end
   end
 end

data/lib/noun-project-api/icon_retriever.rb

@@ -0,0 +1,18 @@
+require 'noun-project-api/retriever'
+
+module NounProjectApi
+  class IconRetriever < Retriever
+    API_PATH = "/icon/"
+
+    def find(id)
+      raise ArgumentError.new('Missing id/slug') unless id
+
+      result = self.access_token.get("#{API_BASE}#{API_PATH}#{id}")
+      raise ArgumentError.new('Bad request') unless result.code == '200'
+
+      Icon.new(result.body)
+    end
+
+    alias_method :find_by_slug, :find
+  end
+end

data/lib/noun-project-api/{icons.rb → icons_retriever.rb}

@@ -2,7 +2,7 @@ require 'noun-project-api/retriever'
 require 'open-uri'
 
 module NounProjectApi
-  class Icons < Retriever
+  class IconsRetriever < Retriever
     API_PATH = "/icons/"
 
     def find(term, limit = nil, offset = nil, page = nil)
@@ -20,7 +20,7 @@ module NounProjectApi
       raise ArgumentError.new('Bad request') unless ['200', '404'].include? result.code
 
       if result.code == '200'
-        JSON.parse(result.body)["icons"]
+        JSON.parse(result.body)["icons"].map { |icon| Icon.new(icon) }
       else
         []
       end
@@ -38,7 +38,7 @@ module NounProjectApi
       result = self.access_token.get("#{API_BASE}#{API_PATH}recent_uploads#{search}")
       raise ArgumentError.new('Bad request') unless result.code == '200'
 
-      JSON.parse(result.body)["recent_uploads"]
+      JSON.parse(result.body)["recent_uploads"].map { |icon| Icon.new(icon) }
     end
   end
 end

data/spec/lib/noun-project-api/icon_retriever_spec.rb

@@ -0,0 +1,85 @@
+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)
+    @valid_response = OpenStruct.new(
+      body: Fakes::Results::ICON_VALID,
+      code: '200'
+    )
+
+    @missing_response = OpenStruct.new(
+      code: '404'
+    )
+  end
+
+  context "id" 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
+      id = 1
+      expect(@icon.access_token).to receive(
+        :get
+      ).with(
+        "#{NounProjectApi::API_BASE}#{NounProjectApi::IconRetriever::API_PATH}#{id}"
+      ).and_return(
+        @valid_response
+      )
+
+      result = @icon.find(id)
+      expect(result).to be_a(NounProjectApi::Icon)
+      expect(result.original_hash).to eq(@valid_hash["icon"])
+    end
+
+    it 'raises an error with a missing id' do
+      id = 1
+      expect(@icon.access_token).to receive(
+        :get
+      ).with(
+        "#{NounProjectApi::API_BASE}#{NounProjectApi::IconRetriever::API_PATH}#{id}"
+      ).and_return(
+        @missing_response
+      )
+
+      expect { @icon.find(id) }.to raise_error(ArgumentError)
+    end
+  end
+
+  context "slug" 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'
+      expect(@icon.access_token).to receive(
+        :get
+      ).with(
+        "#{NounProjectApi::API_BASE}#{NounProjectApi::IconRetriever::API_PATH}#{slug}"
+      ).and_return(
+        @valid_response
+      )
+
+      result = @icon.find(slug)
+      expect(result).to be_a(NounProjectApi::Icon)
+      expect(result.original_hash).to eq(@valid_hash["icon"])
+    end
+
+    it 'raises an error with a missing slug' do
+      slug = 'missing_slug'
+      expect(@icon.access_token).to receive(
+        :get
+      ).with(
+        "#{NounProjectApi::API_BASE}#{NounProjectApi::IconRetriever::API_PATH}#{slug}"
+      ).and_return(
+        @missing_response
+      )
+
+      expect { @icon.find_by_slug(slug) }.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/lib/noun-project-api/icon_spec.rb

@@ -1,81 +1,64 @@
 require 'spec_helper'
 require 'ostruct'
 
-RSpec.describe NounProjectApi::Icon do
-  before :each do
-    @icon = NounProjectApi::Icon.new(Faker::Internet.password(16), Faker::Internet.password(16))
-    @valid_hash = JSON.parse(Fakes::Results::ICON_VALID)
-    @valid_response = OpenStruct.new(
-      body: Fakes::Results::ICON_VALID,
-      code: '200'
-    )
+RSpec.describe NounProjectApi::IconRetriever do
+  it 'raises an error on empty initialization input' do
+    expect { NounProjectApi::Icon.new }.to raise_error(ArgumentError)
+  end
 
-    @missing_response = OpenStruct.new(
-      code: '404'
-    )
+  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
 
-  context "id" do
-    it 'raises an error when no id is provided' do
-      expect { @icon.find(nil) }.to raise_error(ArgumentError)
-    end
+  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
+    data = JSON.parse(Fakes::Results::ICON_VALID)
+    expect { NounProjectApi::Icon.new(data) }.to_not raise_error
+  end
 
-    it 'returns a proper result with a correct id' do
-      id = 1
-      expect(@icon.access_token).to receive(
-        :get
-      ).with(
-        "#{NounProjectApi::API_BASE}#{NounProjectApi::Icon::API_PATH}#{id}"
-      ).and_return(
-        @valid_response
-      )
+  context "exposed attributes" do
+    before :each do
+      @json = JSON.parse(Fakes::Results::ICON_VALID)
+      @valid_icon = NounProjectApi::Icon.new(Fakes::Results::ICON_VALID)
+    end
 
-      expect(@icon.find(id)).to eq(@valid_hash["icon"])
+    it 'public domain' do
+      expect(@valid_icon.public_domain?).to eq(@json["icon"]["license_description"] == "public-domain")
     end
 
-    it 'raises an error with a missing id' do
-      id = 1
-      expect(@icon.access_token).to receive(
-        :get
-      ).with(
-        "#{NounProjectApi::API_BASE}#{NounProjectApi::Icon::API_PATH}#{id}"
-      ).and_return(
-        @missing_response
-      )
+    it 'SVG url' do
+      expect(@valid_icon.svg_url).to eq(@json["icon"]["icon_url"])
+    end
 
-      expect { @icon.find(id) }.to raise_error(ArgumentError)
+    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
-  end
 
-  context "slug" do
-    it 'raises an error when no slug is provided' do
-      expect { @icon.find_by_slug(nil) }.to raise_error(ArgumentError)
+    it 'preview url defaults at 200 size' do
+      expect(@valid_icon.preview_url).to eq(@json["icon"]["preview_url"])
     end
 
-    it 'returns a proper result with a correct slug' do
-      slug = 'existing_slug'
-      expect(@icon.access_token).to receive(
-        :get
-      ).with(
-        "#{NounProjectApi::API_BASE}#{NounProjectApi::Icon::API_PATH}#{slug}"
-      ).and_return(
-        @valid_response
-      )
+    it 'preview url for 200 size' do
+      expect(@valid_icon.preview_url(NounProjectApi::Icon::PREVIEW_SIZE_200)).to eq(@json["icon"]["preview_url"])
+    end
 
-      expect(@icon.find_by_slug(slug)).to eq(@valid_hash["icon"])
+    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 'raises an error with a missing slug' do
-      slug = 'missing_slug'
-      expect(@icon.access_token).to receive(
-        :get
-      ).with(
-        "#{NounProjectApi::API_BASE}#{NounProjectApi::Icon::API_PATH}#{slug}"
-      ).and_return(
-        @missing_response
-      )
+    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
 
-      expect { @icon.find_by_slug(slug) }.to raise_error(ArgumentError)
+    it 'id as number' do
+      expect(@valid_icon.id).to be_a(Fixnum)
+      expect(@valid_icon.id).to eq(@json["icon"]["id"].to_i)
     end
   end
 end

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

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
-RSpec.describe NounProjectApi::Icons do
+RSpec.describe NounProjectApi::IconsRetriever do
   before :each do
-    @icons = NounProjectApi::Icons.new(Faker::Internet.password(16), Faker::Internet.password(16))
+    @icons = NounProjectApi::IconsRetriever.new(Faker::Internet.password(16), Faker::Internet.password(16))
   end
 
   context "recent uploads" do
@@ -16,32 +16,39 @@ RSpec.describe NounProjectApi::Icons do
       expect(@icons.access_token).to receive(
         :get
       ).with(
-        "#{NounProjectApi::API_BASE}#{NounProjectApi::Icons::API_PATH}recent_uploads"
+        "#{NounProjectApi::API_BASE}#{NounProjectApi::IconsRetriever::API_PATH}recent_uploads"
       ).and_return(
         valid_response
       )
 
-      expect(@icons.recent_uploads).to eq(valid_hash["recent_uploads"])
+      results = @icons.recent_uploads
+      expect(results.size).to eq(valid_hash["recent_uploads"].size)
+      results.each do |icon|
+        expect(icon).to be_a(NounProjectApi::Icon)
+      end
     end
 
     it "returns the recent uploads and passes limit when passed" do
-      valid_hash = JSON.parse(Fakes::Results::ICONS_RECENT_VALID)
       valid_response = OpenStruct.new(
         body: Fakes::Results::ICONS_RECENT_VALID,
         code: '200'
       )
 
-      limit = 10
+      limit = 3
 
       expect(@icons.access_token).to receive(
         :get
       ).with(
-        "#{NounProjectApi::API_BASE}#{NounProjectApi::Icons::API_PATH}recent_uploads?limit=#{limit}&"
+        "#{NounProjectApi::API_BASE}#{NounProjectApi::IconsRetriever::API_PATH}recent_uploads?limit=#{limit}&"
       ).and_return(
         valid_response
       )
 
-      expect(@icons.recent_uploads(limit)).to eq(valid_hash["recent_uploads"])
+      results = @icons.recent_uploads(limit)
+      expect(results.size).to eq(limit)
+      results.each do |icon|
+        expect(icon).to be_a(NounProjectApi::Icon)
+      end
     end
   end
 
@@ -61,12 +68,16 @@ RSpec.describe NounProjectApi::Icons do
       expect(@icons.access_token).to receive(
         :get
       ).with(
-        "#{NounProjectApi::API_BASE}#{NounProjectApi::Icons::API_PATH}#{URI::encode(term)}"
+        "#{NounProjectApi::API_BASE}#{NounProjectApi::IconsRetriever::API_PATH}#{URI::encode(term)}"
       ).and_return(
         valid_response
       )
 
-      expect(@icons.find(term)).to eq(valid_hash["icons"])
+      results = @icons.find(term)
+      expect(results.size).to eq(valid_hash["icons"].size)
+      results.each do |icon|
+        expect(icon).to be_a(NounProjectApi::Icon)
+      end
     end
 
     it 'returns a proper result with a correct phrase' do
@@ -80,32 +91,39 @@ RSpec.describe NounProjectApi::Icons do
       expect(@icons.access_token).to receive(
         :get
       ).with(
-        "#{NounProjectApi::API_BASE}#{NounProjectApi::Icons::API_PATH}#{URI::encode(term)}"
+        "#{NounProjectApi::API_BASE}#{NounProjectApi::IconsRetriever::API_PATH}#{URI::encode(term)}"
       ).and_return(
         valid_response
       )
 
-      expect(@icons.find(term)).to eq(valid_hash["icons"])
+      results = @icons.find(term)
+      expect(results.size).to eq(valid_hash["icons"].size)
+      results.each do |icon|
+        expect(icon).to be_a(NounProjectApi::Icon)
+      end
     end
 
     it 'returns a proper result with a correct phrase and passes along the args' do
-      valid_hash = JSON.parse(Fakes::Results::ICONS_VALID)
       valid_response = OpenStruct.new(
         body: Fakes::Results::ICONS_VALID,
         code: '200'
       )
 
       term = 'some search'
-      limit = 10
+      limit = 4
       expect(@icons.access_token).to receive(
         :get
       ).with(
-        "#{NounProjectApi::API_BASE}#{NounProjectApi::Icons::API_PATH}#{URI::encode(term)}?limit=#{limit}&"
+        "#{NounProjectApi::API_BASE}#{NounProjectApi::IconsRetriever::API_PATH}#{URI::encode(term)}?limit=#{limit}&"
       ).and_return(
         valid_response
       )
 
-      expect(@icons.find(term, limit)).to eq(valid_hash["icons"])
+      results = @icons.find(term, limit)
+      expect(results.size).to eq(limit)
+      results.each do |icon|
+        expect(icon).to be_a(NounProjectApi::Icon)
+      end
     end
 
     it 'returns an empty array for no result' do
@@ -117,12 +135,13 @@ RSpec.describe NounProjectApi::Icons do
       expect(@icons.access_token).to receive(
         :get
       ).with(
-        "#{NounProjectApi::API_BASE}#{NounProjectApi::Icons::API_PATH}#{URI::encode(term)}"
+        "#{NounProjectApi::API_BASE}#{NounProjectApi::IconsRetriever::API_PATH}#{URI::encode(term)}"
       ).and_return(
         missing_response
       )
 
-      expect(@icons.find(term)).to eq([])
+      results = @icons.find(term)
+      expect(results.size).to eq(0)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: noun-project-api
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Nadav Shatz
@@ -81,10 +81,12 @@ files:
 - Rakefile
 - lib/noun-project-api.rb
 - lib/noun-project-api/icon.rb
-- lib/noun-project-api/icons.rb
+- lib/noun-project-api/icon_retriever.rb
+- lib/noun-project-api/icons_retriever.rb
 - lib/noun-project-api/retriever.rb
+- spec/lib/noun-project-api/icon_retriever_spec.rb
 - spec/lib/noun-project-api/icon_spec.rb
-- spec/lib/noun-project-api/icons_spec.rb
+- spec/lib/noun-project-api/icons_retriever_spec.rb
 - spec/lib/noun-project-api/retriever_spec.rb
 - spec/spec_helper.rb
 - spec/support/fakes.rb
@@ -113,8 +115,9 @@ signing_key:
 specification_version: 4
 summary: An API wrapper for The Noun Project API's
 test_files:
+- spec/lib/noun-project-api/icon_retriever_spec.rb
 - spec/lib/noun-project-api/icon_spec.rb
-- spec/lib/noun-project-api/icons_spec.rb
+- spec/lib/noun-project-api/icons_retriever_spec.rb
 - spec/lib/noun-project-api/retriever_spec.rb
 - spec/spec_helper.rb
 - spec/support/fakes.rb