gun_broker 0.4.6 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 657189493f5cfb8faf699f3100fe60bd18190012
-  data.tar.gz: c1ccb2b44db024453638d5fa70204da06ce128fb
+  metadata.gz: 337ab5362759c2da234b08bba92463def82f3032
+  data.tar.gz: bc0f1401ca5ea0acd8761df09ac592c5421d8037
 SHA512:
-  metadata.gz: 72ce3a15f96a354f2e93f378a6639b011386418123716304a6be15b839b54a5581a67d3f9bc92566126034166047dd485dc50c5616aea717df42b60c217462e6
-  data.tar.gz: 4c85034d8ebf42def28fb7aa2316326c2fb02f1eea25092ac52e5b85ab05abdc4fe6ff8b1db20cd8910d5de83f87193e3281b394bea7e4ddd453636d9c1d0171
+  metadata.gz: 85131d4627c24cecff1b878ccbcfc62882de9d503d563ec19df6a296ff1e278516dd2d55ee4319fe8522584bd4f5572b988e2aa57f1127c49169ec2816e8d7fc
+  data.tar.gz: 0fad394047ced20e7dd520dbc84e26c0ebcb2d5880022c9b3efd8d9972eeb6dad4812ea7505fdfe61c67b83e7d85b8db0e2ac8fa59dd0229d5d383d3163c867f

data/lib/gun_broker.rb

@@ -3,6 +3,7 @@ require 'gun_broker/version'
 require 'gun_broker/api'
 require 'gun_broker/category'
 require 'gun_broker/error'
+require 'gun_broker/feedback'
 require 'gun_broker/item'
 require 'gun_broker/response'
 require 'gun_broker/user'

data/lib/gun_broker/category.rb

@@ -5,10 +5,10 @@ module GunBroker
     # The top-level category ID.
     ROOT_CATEGORY_ID = 0
 
-    # @param parent [Integer, String] (optional) Return all subcategories of the given parent Category ID; defaults to the root (top-level) categories.
+    # @param parent_id [Integer, String] (optional) Return all subcategories of the given parent Category ID; defaults to the root (top-level) categories.
     # @return [Array<Category>] An array of GunBroker::Category instances.
-    def self.all(parent = ROOT_CATEGORY_ID)
-      response = GunBroker::API.get('/Categories', { 'ParentCategoryID' => parent })
+    def self.all(parent_id = ROOT_CATEGORY_ID)
+      response = GunBroker::API.get('/Categories', { 'ParentCategoryID' => parent_id })
       response['results'].map { |attrs| new(attrs) }
     end
 

data/lib/gun_broker/feedback.rb

@@ -0,0 +1,31 @@
+module GunBroker
+  # Handles feedback about and by a {User}.
+  class Feedback
+
+    # @param user_id [Integer, String] Return feedback by this User's ID.
+    # @return [Array<Feedback>] An array of the User's feedback.
+    def self.all(user_id)
+      response = GunBroker::API.get("/Feedback/#{user_id}")
+      response['results'].map { |attrs| new(attrs) }
+    end
+
+    # @param user_id [Integer, String] Get feedback summary about the `user_id`.
+    # @return [GunBroker::Response]
+    def self.summary(user_id)
+      GunBroker::API.get("/Feedback/Summary/#{user_id}")
+    end
+
+    # @param attrs [Hash] The JSON attributes from the API response.
+    def initialize(attrs = {})
+      @attrs = attrs
+    end
+
+    # @return [GunBroker::Item] The Item this feedback is about.
+    #
+    # See also: {GunBroker::Item.find}
+    def item
+      GunBroker::Item.find(@attrs['itemID'])
+    end
+
+  end
+end

data/lib/gun_broker/item.rb

@@ -6,6 +6,7 @@ module GunBroker
 
     include GunBroker::Item::Constants
 
+    # TODO: Refactor this, #attributes, and #[] into a module.
     # @return [Hash] Attributes parsed from the JSON response.
     attr_reader :attrs
 

data/lib/gun_broker/version.rb

@@ -1,3 +1,3 @@
 module GunBroker
-  VERSION = "0.4.6"
+  VERSION = "0.4.7"
 end

data/spec/fixtures/feedback-summary.json

@@ -0,0 +1,27 @@
+{
+    "isUserRegistered": true,
+    "links": [
+        {
+            "href": "https://api.gunbroker.com/v1/feedback/123",
+            "rel": "details",
+            "title": "test-user",
+            "verb": "GET"
+        }
+    ],
+    "negativeFeedback120Days": 0,
+    "negativeFeedback30Days": 0,
+    "negativeFeedback60Days": 0,
+    "negativeFeedback90Days": 0,
+    "negativeFeedbackPoints": 1,
+    "neutralFeedbackPoints": 0,
+    "positiveFeedbackPercentage": 50.0,
+    "positiveFeedbackPoints": 1,
+    "totalFeedbackPoints": 2,
+    "user": {
+        "feedbackRating": "C(2)",
+        "isVerified": true,
+        "isffl": false,
+        "userID": 123,
+        "username": "tet-user"
+    }
+}

data/spec/fixtures/feedback.json

@@ -0,0 +1,76 @@
+{
+    "count": 2,
+    "links": [],
+    "pageIndex": 1,
+    "pageSize": 25,
+    "results": [
+        {
+            "buyerSellerStatus": "S",
+            "comment": "Never received item. Seller would not respond to emails or phone message. Money refunded 11 days after payment was sent only after filing a dispute with PayPal. Don't recommend dealing w/ this person.",
+            "date": "2014-08-22T20:57:19Z",
+            "followUp": null,
+            "followUpDate": null,
+            "fromUser": {
+                "feedbackRating": "A+(13)",
+                "isVerified": true,
+                "isffl": false,
+                "userID": 12345,
+                "username": "joe-user"
+            },
+            "isRegistered": true,
+            "itemID": 123,
+            "links": [
+                {
+                    "href": "https://api.gunbroker.com/v1/items/123",
+                    "rel": "item",
+                    "title": "123",
+                    "verb": "GET"
+                },
+                {
+                    "href": "https://api.gunbroker.com/v1/feedback/12345",
+                    "rel": "fromuserfeedback",
+                    "title": "joe-user",
+                    "verb": "GET"
+                }
+            ],
+            "ratingLetter": "F",
+            "ratingScore": 0.0,
+            "reply": null,
+            "replyDate": null
+        },
+        {
+            "buyerSellerStatus": "S",
+            "comment": "Excellent transaction.  Good communication.  A+",
+            "date": "2014-07-09T19:46:57Z",
+            "followUp": null,
+            "followUpDate": null,
+            "fromUser": {
+                "feedbackRating": "A+(94)",
+                "isVerified": true,
+                "isffl": false,
+                "userID": 9876,
+                "username": "other-user"
+            },
+            "isRegistered": true,
+            "itemID": 530,
+            "links": [
+                {
+                    "href": "https://api.gunbroker.com/v1/items/530",
+                    "rel": "item",
+                    "title": "414806299",
+                    "verb": "GET"
+                },
+                {
+                    "href": "https://api.gunbroker.com/v1/feedback/9876",
+                    "rel": "fromuserfeedback",
+                    "title": "other-user",
+                    "verb": "GET"
+                }
+            ],
+            "ratingLetter": "A+",
+            "ratingScore": 5.0,
+            "reply": null,
+            "replyDate": null
+        }
+    ]
+}

data/spec/gun_broker/feedback_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe GunBroker::Feedback do
+
+  let(:attrs) { JSON.parse(response_fixture('feedback')) }
+
+  let(:user_id) { 123 }
+  let(:endpoint) { [GunBroker::API::GUNBROKER_API, "/Feedback/#{user_id}"].join }
+  let(:summary_endpoint) { [GunBroker::API::GUNBROKER_API, "/Feedback/Summary/#{user_id}"].join }
+
+  context '.all' do
+    it 'returns an array of the user feedback' do
+      stub_request(:get, endpoint)
+        .with(headers: headers)
+        .to_return(body: response_fixture('feedback'))
+
+      feedback = GunBroker::Feedback.all(user_id)
+      expect(feedback.first).to be_a(GunBroker::Feedback)
+    end
+  end
+
+  context '.summary' do
+    it 'returns an array of the user feedback' do
+      stub_request(:get, summary_endpoint)
+        .with(headers: headers)
+        .to_return(body: response_fixture('feedback-summary'))
+
+      summary = GunBroker::Feedback.summary(user_id)
+      expect(summary).to be_a(GunBroker::Response)
+    end
+  end
+
+  context '#item' do
+    let(:item_id) { attrs['results'].first['itemID'] }
+    let(:item_endpoint) { [GunBroker::API::GUNBROKER_API, "/Items/#{item_id}"].join }
+
+    it 'should have an Item' do
+      stub_request(:get, endpoint)
+        .with(headers: headers)
+        .to_return(body: response_fixture('feedback'))
+
+      stub_request(:get, item_endpoint)
+        .with(headers: headers)
+        .to_return(body: response_fixture('item'))
+
+      all_feedback = GunBroker::Feedback.all(user_id)
+      feedback = all_feedback.first
+
+      expect(feedback.item).to be_a(GunBroker::Item)
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gun_broker
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.4.7
 platform: ruby
 authors:
 - Dale Campbell
@@ -101,6 +101,7 @@ files:
 - lib/gun_broker/api.rb
 - lib/gun_broker/category.rb
 - lib/gun_broker/error.rb
+- lib/gun_broker/feedback.rb
 - lib/gun_broker/item.rb
 - lib/gun_broker/item/constants.rb
 - lib/gun_broker/response.rb
@@ -114,6 +115,8 @@ files:
 - spec/fixtures/contact_info.json
 - spec/fixtures/deauthenticate.json
 - spec/fixtures/empty.json
+- spec/fixtures/feedback-summary.json
+- spec/fixtures/feedback.json
 - spec/fixtures/item.json
 - spec/fixtures/items.json
 - spec/fixtures/not_authorized.json
@@ -121,6 +124,7 @@ files:
 - spec/fixtures/time.json
 - spec/gun_broker/api_spec.rb
 - spec/gun_broker/category_spec.rb
+- spec/gun_broker/feedback_spec.rb
 - spec/gun_broker/item/constants_spec.rb
 - spec/gun_broker/item_spec.rb
 - spec/gun_broker/token_header_spec.rb
@@ -161,6 +165,8 @@ test_files:
 - spec/fixtures/contact_info.json
 - spec/fixtures/deauthenticate.json
 - spec/fixtures/empty.json
+- spec/fixtures/feedback-summary.json
+- spec/fixtures/feedback.json
 - spec/fixtures/item.json
 - spec/fixtures/items.json
 - spec/fixtures/not_authorized.json
@@ -168,6 +174,7 @@ test_files:
 - spec/fixtures/time.json
 - spec/gun_broker/api_spec.rb
 - spec/gun_broker/category_spec.rb
+- spec/gun_broker/feedback_spec.rb
 - spec/gun_broker/item/constants_spec.rb
 - spec/gun_broker/item_spec.rb
 - spec/gun_broker/token_header_spec.rb