noun-project-api 0.2.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3c7ae7b8b1f25961ef2fe19d378c2d94055e98dd
-  data.tar.gz: c2530ecfc949d889e96118a6d9f954ee3a5348a8
+SHA256:
+  metadata.gz: dc6c2457656761dd7e1bed16e52f00c5558a4f632a354f3fa7c626b90664b09b
+  data.tar.gz: 184f196a2a7d1da39cc8988d0f7384374220a12a66cb495c06d52a53a3ee74ae
 SHA512:
-  metadata.gz: 4a72e78652f89a94ca39594381818889b65e942e912541d9c4180f5c8e2fe6549de04596caedb23267c832406d4bb789659e0bc32ebccace3334d64350f14726
-  data.tar.gz: acbd1591de900a72773d6de5f664f0a4f42a6fa94606e01dac602830fad0572f2ef8476f028d2afbf56dc60042f59ca8f929fc4c9ba1aea6d5083f0944f8811c
+  metadata.gz: cf73f5f81a56f940567d2bff8b9dbeb0631d9e7f32f973bf5a29a2f541356420e5651a3c2d48705cd6823890a18d9f71ca2b45c4ad709fe80fad72c8ae41e473
+  data.tar.gz: ae830b9869b6b10dea4b2287d511f7274692b6875776074d9c46eb5a706f0f63e984088eccb07b938087bbe943904ef4cc68762b74eee195db6c883985245bcf

data/lib/noun-project-api.rb

@@ -1,14 +1,18 @@
-require 'oauth'
-require 'json'
-require 'noun-project-api/connection'
-require 'noun-project-api/icon_retriever'
-require 'noun-project-api/reporter'
-require 'noun-project-api/icons_retriever'
-require 'noun-project-api/icon'
+require "oauth"
+require "active_support"
+require "json"
+require "noun-project-api/errors"
+require "noun-project-api/connection"
+require "noun-project-api/icon_retriever"
+require "noun-project-api/reporter"
+require "noun-project-api/icons_retriever"
+require "noun-project-api/icon"
+require "noun-project-api/collection_retriever"
+require "noun-project-api/collection"
 
 # Top level name space for the entire Gem.
 module NounProjectApi
-  API_BASE = 'http://api.thenounproject.com'
+  API_BASE = "http://api.thenounproject.com".freeze
 
   def self.configuration
     @configuration ||=  Configuration.new
@@ -21,10 +25,11 @@ module NounProjectApi
 
   # Main configuration class.
   class Configuration
-    attr_accessor :public_domain
+    attr_accessor :public_domain, :cache
 
     def initialize
       @public_domain = false
+      @cache = ActiveSupport::Cache::NullStore.new
     end
   end
 end

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

@@ -0,0 +1,26 @@
+module NounProjectApi
+  # A basis to Items returned by the noun project.
+  class BaseItem
+    attr_accessor :original_hash
+    ITEM_NAME = nil
+
+    def initialize(origin)
+      raise NotImplementedError.new("Must use a subclass") if self.class::ITEM_NAME.nil?
+
+      origin = JSON.parse(origin) if origin.is_a? String
+      origin = origin.delete(
+        self.class::ITEM_NAME
+      ) if origin.key? self.class::ITEM_NAME
+
+      @original_hash = origin
+    end
+
+    def id
+      original_hash["id"].to_i
+    end
+
+    def to_json
+      JSON.dump(to_hash)
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+require "noun-project-api/base_item"
+
+module NounProjectApi
+  # A single Collection as an abstracted ruby object.
+  class Collection < BaseItem
+    ITEM_NAME = "collection".freeze
+
+    def author_id
+      original_hash["author_id"].to_i
+    end
+
+    def author_name
+      original_hash["author"]["name"]
+    end
+
+    def icon_count
+      original_hash["icon_count"].to_i
+    end
+
+    def is_published?
+      original_hash["is_published"].to_i == 1
+    end
+
+    def to_hash
+      {
+        id: id,
+        author_id: author_id,
+        author_name: author_name,
+        icon_count: icon_count,
+        is_published: is_published?
+      }
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+require "noun-project-api/collection"
+require "noun-project-api/retriever"
+
+module NounProjectApi
+  # Retrieve a collection.
+  class CollectionRetriever < Retriever
+    API_PATH = "/collection/".freeze
+    ITEM_CLASS = Collection
+
+    alias_method :find_by_slug, :find
+  end
+end

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

@@ -6,7 +6,7 @@ module NounProjectApi
     def initialize(token, secret)
       @token = token
       @secret = secret
-      fail(ArgumentError, 'Missing token or secret') unless @token && @secret
+      raise ArgumentError.new("Missing token or secret") unless @token && @secret
 
       @access_token = OAuth::AccessToken.new(OAuth::Consumer.new(token, secret))
     end

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

@@ -0,0 +1,12 @@
+module NounProjectApi
+  class ServiceError < StandardError
+    attr_reader :status, :body
+
+    def initialize(status, body)
+      @status = status
+      @body = body
+
+      super("Noun Project API Error")
+    end
+  end
+end

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

@@ -1,36 +1,27 @@
+require "noun-project-api/base_item"
+
 module NounProjectApi
   # A single Icon as an abstracted ruby object.
-  class Icon
+  class Icon < BaseItem
     PREVIEW_SIZE_200 = 200
     PREVIEW_SIZE_42 = 42
     PREVIEW_SIZE_84 = 84
 
-    PUBLIC_DOMAIN_LICENSE = 'public-domain'
-
-    attr_accessor :original_hash
-
-    def initialize(origin)
-      origin = JSON.parse(origin) if origin.is_a? String
-      origin = origin.delete('icon') if origin.key? 'icon'
-
-      @original_hash = origin
-    end
+    PUBLIC_DOMAIN_LICENSE = "public-domain".freeze
 
-    def id
-      original_hash['id'].to_i
-    end
+    ITEM_NAME = "icon".freeze
 
     def public_domain?
-      original_hash['license_description'] == PUBLIC_DOMAIN_LICENSE
+      original_hash["license_description"] == PUBLIC_DOMAIN_LICENSE
     end
 
     def svg_url
-      original_hash['icon_url']
+      original_hash["icon_url"]
     end
 
     def preview_url(size = PREVIEW_SIZE_200)
       if size == PREVIEW_SIZE_200
-        original_hash['preview_url']
+        original_hash["preview_url"]
       else
         original_hash["preview_url_#{size}"]
       end
@@ -44,9 +35,5 @@ module NounProjectApi
         preview_url_42: preview_url(PREVIEW_SIZE_42)
       }
     end
-
-    def to_json
-      JSON.dump(to_hash)
-    end
   end
 end

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

@@ -1,19 +1,11 @@
-require 'noun-project-api/retriever'
+require "noun-project-api/icon"
+require "noun-project-api/retriever"
 
 module NounProjectApi
   # Retrieve an icon.
   class IconRetriever < Retriever
-    API_PATH = '/icon/'
-
-    # Find an icon based on it's id.
-    def find(id)
-      fail(ArgumentError, 'Missing id/slug') unless id
-
-      result = access_token.get("#{API_BASE}#{API_PATH}#{id}")
-      fail(ArgumentError, 'Bad request') unless result.code == '200'
-
-      Icon.new(result.body)
-    end
+    API_PATH = "/icon/".freeze
+    ITEM_CLASS = Icon
 
     alias_method :find_by_slug, :find
   end

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

@@ -1,9 +1,9 @@
-require 'noun-project-api/retriever'
+require "noun-project-api/retriever"
 
 module NounProjectApi
   # Retrieve icons.
   class IconsRetriever < Retriever
-    API_PATH = '/icons/'
+    API_PATH = "/icons/".freeze
 
     # Finds multiple icons based on the term
     # * term - search term
@@ -11,21 +11,29 @@ module NounProjectApi
     # * offset - offset the results
     # * page - page number
     def find(term, limit = nil, offset = nil, page = nil)
-      fail(ArgumentError, 'Missing search term') unless term
+      cache_key = Digest::MD5.hexdigest("#{term}+#{limit}+#{offset}+#{page}")
 
-      search = OAuth::Helper.escape(term)
-      search += "?limit_to_public_domain=#{NounProjectApi.configuration.public_domain ? 1 : 0}"
+      NounProjectApi.configuration.cache.fetch(cache_key) do
+        raise ArgumentError.new("Missing search term") unless term
 
-      args = { 'limit' => limit, 'offset' => offset, 'page' => page }.reject { |_, v| v.nil? }
-      args.each { |k, v| search += "&#{k}=#{v}" } if args.size > 0
+        search = OAuth::Helper.escape(term)
+        search += "?limit_to_public_domain=#{NounProjectApi.configuration.public_domain ? 1 : 0}"
 
-      result = access_token.get("#{API_BASE}#{API_PATH}#{search}")
-      fail(ArgumentError, 'Bad request') unless %w(200 404).include? result.code
+        args = {
+          "limit" => limit,
+          "offset" => offset,
+          "page" => page
+        }.reject { |_, v| v.nil? }
+        args.each { |k, v| search += "&#{k}=#{v}" } if args.size > 0
 
-      if result.code == '200'
-        JSON.parse(result.body)['icons'].map { |icon| Icon.new(icon) }
-      else
-        []
+        result = access_token.get("#{API_BASE}#{API_PATH}#{search}")
+        raise ServiceError.new(result.code, result.body) unless %w(200 404).include? result.code
+
+        if result.code == "200"
+          JSON.parse(result.body)["icons"].map { |icon| Icon.new(icon) }
+        else
+          []
+        end
       end
     end
 
@@ -34,18 +42,22 @@ module NounProjectApi
     # * offset - offset the results
     # * page - page number
     def recent_uploads(limit = nil, offset = nil, page = nil)
-      args = { 'limit' => limit, 'offset' => offset, 'page' => page }.reject { |k, v| v.nil? }
+      args = {
+        "limit" => limit,
+        "offset" => offset,
+        "page" => page
+      }.reject { |_, v| v.nil? }
       if args.size > 0
-        search = '?'
+        search = "?"
         args.each { |k, v| search += "#{k}=#{v}&" }
       else
-        search = ''
+        search = ""
       end
 
       result = access_token.get("#{API_BASE}#{API_PATH}recent_uploads#{search}")
-      fail(ArgumentError, 'Bad request') unless result.code == '200'
+      raise ServiceError.new(result.code, result.body) unless result.code == "200"
 
-      JSON.parse(result.body)['recent_uploads'].map { |icon| Icon.new(icon) }
+      JSON.parse(result.body)["recent_uploads"].map { |icon| Icon.new(icon) }
     end
   end
 end

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

@@ -3,14 +3,18 @@ module NounProjectApi
   class Reporter
     include Connection
 
-    API_PATH = '/notify/publish'
+    API_PATH = "/notify/publish".freeze
 
     def report_used(ids)
       ids = [ids] if ids.is_a?(String) || ids.is_a?(Fixnum)
-      fail(ArgumentError, 'Missing ids') if ids.nil? || ids.empty?
+      raise ArgumentError.new("Missing ids") if ids.nil? || ids.empty?
 
-      result = access_token.post("#{API_BASE}#{API_PATH}", icons: ids.join(','))
-      result.code == '200'
+      result = access_token.post(
+        "#{API_BASE}#{API_PATH}",
+        { icons: ids.join(",") }.to_json,
+        "Accept" => "application/json", "Content-Type" => "application/json"
+      )
+      result.code == "200"
     end
   end
 end

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

@@ -2,5 +2,15 @@ module NounProjectApi
   # A base class for different retriever classes.
   class Retriever
     include Connection
+
+    # Find an item based on it's id.
+    def find(id)
+      raise ArgumentError.new("Missing id/slug") unless id
+
+      result = access_token.get("#{API_BASE}#{self.class::API_PATH}#{id}")
+      raise ServiceError.new(result.code, result.body) unless result.code == "200"
+
+      self.class::ITEM_CLASS.new(result.body)
+    end
   end
 end

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

@@ -0,0 +1,11 @@
+require "spec_helper"
+require "ostruct"
+
+RSpec.describe NounProjectApi::BaseItem do
+  it "raises an error on direct initialization" do
+    data = JSON.parse(Fakes::Results::ICON_VALID)
+    expect {
+      NounProjectApi::BaseItem.new(JSON.dump(data["icon"]))
+    }.to raise_error(NotImplementedError)
+  end
+end

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

@@ -0,0 +1,85 @@
+require "spec_helper"
+require "ostruct"
+
+RSpec.describe NounProjectApi::CollectionRetriever do
+  before :each do
+    @collection = NounProjectApi::CollectionRetriever.new(Faker::Internet.password(min_length: 16), Faker::Internet.password(min_length: 16))
+    @valid_hash = JSON.parse(Fakes::Results::COLLECTION_VALID)
+    @valid_response = OpenStruct.new(
+      body: Fakes::Results::COLLECTION_VALID,
+      code: "200"
+    )
+
+    @missing_response = OpenStruct.new(
+      code: "404"
+    )
+  end
+
+  context "id" do
+    it "raises an error when no id is provided" do
+      expect { @collection.find(nil) }.to raise_error(ArgumentError)
+    end
+
+    it "returns a proper result with a correct id" do
+      id = 1
+      expect(@collection.access_token).to receive(
+        :get
+      ).with(
+        "#{NounProjectApi::API_BASE}#{NounProjectApi::CollectionRetriever::API_PATH}#{id}"
+      ).and_return(
+        @valid_response
+      )
+
+      result = @collection.find(id)
+      expect(result).to be_a(NounProjectApi::Collection)
+      expect(result.original_hash).to eq(@valid_hash["collection"])
+    end
+
+    it "raises an error with a missing id" do
+      id = 1
+      expect(@collection.access_token).to receive(
+        :get
+      ).with(
+        "#{NounProjectApi::API_BASE}#{NounProjectApi::CollectionRetriever::API_PATH}#{id}"
+      ).and_return(
+        @missing_response
+      )
+
+      expect { @collection.find(id) }.to raise_error(NounProjectApi::ServiceError)
+    end
+  end
+
+  context "slug" do
+    it "raises an error when no slug is provided" do
+      expect { @collection.find_by_slug(nil) }.to raise_error(ArgumentError)
+    end
+
+    it "returns a proper result with a correct slug" do
+      slug = "existing_slug"
+      expect(@collection.access_token).to receive(
+        :get
+      ).with(
+        "#{NounProjectApi::API_BASE}#{NounProjectApi::CollectionRetriever::API_PATH}#{slug}"
+      ).and_return(
+        @valid_response
+      )
+
+      result = @collection.find(slug)
+      expect(result).to be_a(NounProjectApi::Collection)
+      expect(result.original_hash).to eq(@valid_hash["collection"])
+    end
+
+    it "raises an error with a missing slug" do
+      slug = "missing_slug"
+      expect(@collection.access_token).to receive(
+        :get
+      ).with(
+        "#{NounProjectApi::API_BASE}#{NounProjectApi::CollectionRetriever::API_PATH}#{slug}"
+      ).and_return(
+        @missing_response
+      )
+
+      expect { @collection.find_by_slug(slug) }.to raise_error(NounProjectApi::ServiceError)
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+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(Fixnum)
+      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.is_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,
+        is_published: @valid_collection.is_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/icon_retriever_spec.rb

@@ -1,26 +1,26 @@
-require 'spec_helper'
-require 'ostruct'
+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))
+    @icon = NounProjectApi::IconRetriever.new(Faker::Internet.password(min_length: 16), Faker::Internet.password(min_length: 16))
     @valid_hash = JSON.parse(Fakes::Results::ICON_VALID)
     @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
@@ -35,7 +35,7 @@ RSpec.describe NounProjectApi::IconRetriever do
       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 +45,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(
@@ -69,8 +69,8 @@ RSpec.describe NounProjectApi::IconRetriever do
       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 +79,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/icon_spec.rb

@@ -1,21 +1,21 @@
-require 'spec_helper'
-require 'ostruct'
+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,42 +26,42 @@ 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
+    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
 
-    it 'builds a simple hash' do
+    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),
@@ -70,7 +70,7 @@ RSpec.describe NounProjectApi::IconRetriever do
       })
     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/icons_retriever_spec.rb

@@ -1,8 +1,8 @@
-require 'spec_helper'
+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 +10,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 +31,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,18 +53,18 @@ 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(
@@ -80,14 +80,14 @@ 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(
@@ -103,14 +103,14 @@ 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(
@@ -128,13 +128,13 @@ 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
@@ -151,12 +151,12 @@ 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(

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

@@ -1,34 +1,34 @@
-require 'spec_helper'
+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
@@ -37,7 +37,8 @@ RSpec.describe NounProjectApi::Reporter do
         :post
       ).with(
         "#{NounProjectApi::API_BASE}#{NounProjectApi::Reporter::API_PATH}",
-        icons: id.to_s
+        { icons: id.to_s }.to_json,
+        "Accept" => "application/json", "Content-Type" => "application/json"
       ).and_return(
         valid_response
       )
@@ -46,19 +47,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
+        { icons: id }.to_json,
+        "Accept" => "application/json", "Content-Type" => "application/json"
       ).and_return(
         valid_response
       )
@@ -69,10 +71,10 @@ RSpec.describe NounProjectApi::Reporter do
 
 
 
-    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]
@@ -81,7 +83,8 @@ RSpec.describe NounProjectApi::Reporter do
         :post
       ).with(
         "#{NounProjectApi::API_BASE}#{NounProjectApi::Reporter::API_PATH}",
-        icons: ids.join(',')
+        { icons: ids.join(",") }.to_json,
+        "Accept" => "application/json", "Content-Type" => "application/json"
       ).and_return(
         valid_response
       )

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

@@ -1,17 +1,17 @@
-require 'spec_helper'
+require "spec_helper"
 
 RSpec.describe NounProjectApi::Retriever do
-  it 'raises an error when initialized without token' do
-    expect { NounProjectApi::Retriever.new(nil, Faker::Internet.password(16)) }.to raise_error(ArgumentError)
+  it "raises an error when initialized without token" do
+    expect { NounProjectApi::Retriever.new(nil, Faker::Internet.password(min_length: 16)) }.to raise_error(ArgumentError)
   end
 
-  it 'raises an error when initialized without secret' do
-    expect { NounProjectApi::Retriever.new(Faker::Internet.password(16), nil) }.to raise_error(ArgumentError)
+  it "raises an error when initialized without secret" do
+    expect { NounProjectApi::Retriever.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)
     retriever = NounProjectApi::Retriever.new(token, secret)
 
     expect(retriever.token).to eq(token)

data/spec/lib/nount_project_api_spec.rb

@@ -1,11 +1,11 @@
-require 'spec_helper'
+require "spec_helper"
 
 RSpec.describe NounProjectApi do
-  it 'has the correct default' do
+  it "has the correct default" do
     expect(NounProjectApi.configuration.public_domain).to be false
   end
 
-  it 'sets the correct configuration' do
+  it "sets the correct configuration" do
     expect(NounProjectApi.configuration.public_domain).to be false
 
     NounProjectApi.configure do |config|

data/spec/spec_helper.rb

@@ -1,11 +1,8 @@
-require "codeclimate-test-reporter"
-CodeClimate::TestReporter.start
-
 require "bundler/setup"
 require "noun-project-api"
 require "pry"
 require "faker"
-require 'json'
+require "json"
 
 require_relative "support/fakes"
 

data/spec/support/fakes.rb

@@ -308,5 +308,86 @@ module Fakes
   "licenses_consumed": 1,
   "result": "success"
 }'''
+
+    COLLECTION_VALID = '''
+    {
+    "collection": {
+      "author": {
+        "location": "US",
+        "name": "irene hoffman",
+        "permalink": "/i",
+        "username": "i"
+      },
+      "author_id": "5562",
+      "date_created": "2014-06-27 00:22:22",
+      "date_updated": "2014-06-27 00:22:22",
+      "description": "",
+      "icon_count": "4",
+      "id": "321",
+      "is_collaborative": "",
+      "is_featured": "0",
+      "is_published": "1",
+      "is_store_item": "0",
+      "name": "genetics",
+      "permalink": "/i/collection/genetics",
+      "slug": "genetics",
+      "sponsor": {},
+      "sponsor_campaign_link": "",
+      "sponsor_id": "",
+      "tags": [
+        "genetics",
+        "chromosome",
+        "gene",
+        "heredity",
+        "genetic code",
+        "nucleic acid",
+        "RNA",
+        "DNA",
+        "deoxyribonucleic acid",
+        "reproduction",
+        "genome",
+        "human",
+        "chemistry",
+        "Allele",
+        "Amelogenin",
+        "bases",
+        "building blocks",
+        "cytosine",
+        "guanine",
+        "thymine",
+        "adenine",
+        "c",
+        "G",
+        "T",
+        "CGTA",
+        "A",
+        "biological",
+        "cell",
+        "CODIS",
+        "blueprint of life",
+        "life",
+        "material",
+        "nucleus",
+        "inherited",
+        "parent",
+        "unique",
+        "analysis",
+        "double helix",
+        "helix",
+        "forensic",
+        "loci",
+        "genotype",
+        "haplotype",
+        "junk DNA",
+        "match",
+        "nuclear",
+        "paternal",
+        "sequence",
+        "sequencing"
+      ],
+      "template": "24"
+    }
+}
+'''
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: noun-project-api
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Nadav Shatz
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-03-17 00:00:00.000000000 Z
+date: 2020-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
@@ -16,12 +16,26 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -30,62 +44,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.13'
 - !ruby/object:Gem::Dependency
   name: semver
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
 description: A Gem to expose a wrapping API for The Noun Project API's
 email: nadav@tailorbrands.com
 executables: []
@@ -94,12 +130,19 @@ extra_rdoc_files: []
 files:
 - Rakefile
 - lib/noun-project-api.rb
+- lib/noun-project-api/base_item.rb
+- lib/noun-project-api/collection.rb
+- lib/noun-project-api/collection_retriever.rb
 - lib/noun-project-api/connection.rb
+- lib/noun-project-api/errors.rb
 - lib/noun-project-api/icon.rb
 - lib/noun-project-api/icon_retriever.rb
 - lib/noun-project-api/icons_retriever.rb
 - lib/noun-project-api/reporter.rb
 - lib/noun-project-api/retriever.rb
+- spec/lib/noun-project-api/base_item_spec.rb
+- spec/lib/noun-project-api/collection_retriever_spec.rb
+- spec/lib/noun-project-api/collection_spec.rb
 - spec/lib/noun-project-api/icon_retriever_spec.rb
 - spec/lib/noun-project-api/icon_spec.rb
 - spec/lib/noun-project-api/icons_retriever_spec.rb
@@ -112,7 +155,7 @@ homepage: https://github.com/TailorBrands/noun-project-api
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -127,17 +170,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.1.2
+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_retriever_spec.rb
-- spec/lib/noun-project-api/reporter_spec.rb
-- spec/lib/noun-project-api/retriever_spec.rb
-- spec/lib/nount_project_api_spec.rb
 - spec/spec_helper.rb
 - spec/support/fakes.rb
+- spec/lib/nount_project_api_spec.rb
+- spec/lib/noun-project-api/collection_spec.rb
+- spec/lib/noun-project-api/icon_spec.rb
+- spec/lib/noun-project-api/base_item_spec.rb
+- spec/lib/noun-project-api/collection_retriever_spec.rb
+- spec/lib/noun-project-api/retriever_spec.rb
+- spec/lib/noun-project-api/icon_retriever_spec.rb
+- spec/lib/noun-project-api/reporter_spec.rb
+- spec/lib/noun-project-api/icons_retriever_spec.rb