Merge remote-tracking branch 'origin' into fix/add_create_or_update_method_to_collection

Author: ecoologic

.github/workflows/main.yml

@@ -14,10 +14,10 @@ jobs:
  strategy:
  matrix:
  ruby:
- - 2.5
  - 2.6
  - 2.7
  - 3.0
+ - 3.1
  - jruby-9.1
  - jruby-9.2
  steps:

README.md

@@ -1,6 +1,6 @@
 # Zendesk API Client
 
-![Test](https://github.com/zendesk/zendesk_api_client_rb/workflows/Test/badge.svg)
+[![Test](https://github.com/zendesk/zendesk_api_client_rb/workflows/Test/badge.svg)](https://github.com/zendesk/zendesk_api_client_rb/actions/workflows/main.yml?query=branch%3Amaster)
 [![Gem Version](https://badge.fury.io/rb/zendesk_api.svg)](https://badge.fury.io/rb/zendesk_api)
 [![Code Climate](https://codeclimate.com/github/zendesk/zendesk_api_client_rb.svg)](https://codeclimate.com/github/zendesk/zendesk_api_client_rb)
 
@@ -227,6 +227,7 @@ To facilitate a smaller number of requests and easier manipulation of associated
 For example:
 A `ZendeskAPI::Ticket` is associated with `ZendeskAPI::User` through the `requester_id` field.
 API requests for that ticket return a structure similar to this:
+
 ```json
 "ticket": {
  "id": 1,
@@ -244,11 +245,9 @@ tickets = client.tickets.include(:users)
 # Or client.tickets(:include => :users)
 # Does *NOT* make a request to the server since it is already loaded
 tickets.first.requester # => #<ZendeskAPI::User id=...>
-```
 
-OR
+# OR
 
-```ruby
 ticket = client.tickets.find!(:id => 1, :include => :users)
 ticket.requester # => #<ZendeskAPI::User id=...>
 ```
@@ -426,7 +425,17 @@ installation.destroy!
 ZendeskAPI::AppInstallation.destroy!(client, :id => 123)
 ```
 
-## Note on Patches/Pull Requests
+## Running the gem locally
+
+See `.github/workflows/main.yml` to understand the CI process.
+
+```
+bundle exec rake # Runs the tests
+bundle exec rubocop # Runs the lint (use `--fix` for autocorrect)
+```
+
+## Contributing
+
 1. Fork the project.
 2. Make your feature addition or bug fix.
 3. Add tests for it. This is important so that we don't break it in a future
@@ -438,7 +447,7 @@ ZendeskAPI::AppInstallation.destroy!(client, :id => 123)
 
 ## Copyright and license
 
-Copyright 2015-2021 Zendesk
+Copyright 2015-2022 Zendesk
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

lib/zendesk_api/collection.rb

@@ -187,7 +187,7 @@ def fetch!(reload = false)
  end
  path_query_link = (@query || path)
  @response = get_response(path_query_link)
- 
+
  if path_query_link == "search/export"
  handle_cursor_response(@response.body)
  else
@@ -318,28 +318,23 @@ def to_s
  end
  end
 
- alias :to_str :to_s
-
  def to_param
  map(&:to_param)
  end
 
- def has_more_results?(response)
- return false unless response["meta"].present? && response["results"].present?
-
- response["meta"]["has_more"] && response["results"].length > 0
+ def more_results?(response)
+ response["meta"].present? && response["results"].present?
  end
+ alias_method :has_more_results?, :more_results? # For backward compatibility with 1.33.0 and 1.34.0
 
  def get_response_body(link)
- response_body = @client.connection.send("get", link).body
-
- response_body
+ @client.connection.send("get", link).body
  end
 
  def get_next_page_data(original_response_body)
  link = original_response_body["links"]["next"]
 
- while link do
+ while link
  response = get_response_body(link)
 
  original_response_body["results"] = original_response_body["results"] + response["results"]
@@ -446,7 +441,7 @@ def handle_cursor_response(response_body)
  raise ZendeskAPI::Error::NetworkError, @response.env
  end
 
- response_body = get_next_page_data(response_body) if has_more_results?(response_body)
+ response_body = get_next_page_data(response_body) if more_results?(response_body)
 
  body = response_body.dup
  results = body.delete(@resource_class.model_key) || body.delete("results")

spec/core/collection_spec.rb

@@ -883,17 +883,18 @@ def to_proc
 
  it "should not have more results" do
  stub_json_request(:get, %r{search/export\?query=hello}, json(:results => [],
- :meta => {has_more: false}))
+ :meta => { has_more: false }))
 
  subject.fetch
  response = subject.instance_variable_get(:@response).body
+ expect(subject.more_results?(response)).to be(false)
  expect(subject.has_more_results?(response)).to be(false)
  end
 
  it "should not have more pages data" do
  stub_json_request(:get, %r{search/export\?query=hello}, json(:results => [],
- :meta => {has_more: false},
- :links => {:next => nil}))
+ :meta => { has_more: false },
+ :links => { :next => nil }))
 
  subject.fetch
  response = subject.instance_variable_get(:@response).body

spec/core/search_export_spec.rb

@@ -1,21 +1,21 @@
 require 'core/spec_helper'
 
 describe ZendeskAPI::SearchExport do
- context ".new" do
+ describe ".new" do
  context "when given an existing class" do
- it "should return the correct class" do
- expect(ZendeskAPI::SearchExport.new(nil, { "result_type" => "user" })).to be_instance_of(ZendeskAPI::User)
+ it "returns an instance of the specific class" do
+ expect(ZendeskAPI::SearchExport.new(nil, "result_type" => "user")).to be_instance_of(ZendeskAPI::User)
  end
  end
 
  context "when given a nonexistent class" do
- it "should return an object of the type Search::Result" do
- expect(ZendeskAPI::SearchExport.new(nil, { "result_type" => "blah" })).to be_instance_of(ZendeskAPI::SearchExport::Result)
+ it "returns an instance of the generic Search::Result" do
+ expect(ZendeskAPI::SearchExport.new(nil, "result_type" => "blah")).to be_instance_of(ZendeskAPI::SearchExport::Result)
  end
  end
 
  context "when not given anything" do
- it "should return an object of the type Search::Result" do
+ it "returns an instance of Search::Result by default" do
  expect(ZendeskAPI::SearchExport.new(nil, {})).to be_instance_of(ZendeskAPI::SearchExport::Result)
  end
  end