Class: Furaffinity::Client

Inherits:
Object
  • Object
show all
Includes:
SemanticLogger::Loggable
Defined in:
lib/furaffinity/client.rb

Constant Summary collapse

BASE_URL = 
"https://www.furaffinity.net"
NOTIFICATIONS_MAP = 
{
  "submission"    => :submissions,
  "watch"         => :watches,
  "comment"       => :comments,
  "favorite"      => :favourites,
  "journal"       => :journals,
  "unread"        => :notes,
  "troubleticket" => :trouble_tickets,
}
SUBMISSION_TYPES = 
%i[submission story poetry music].freeze
RATING_MAP = 
{
  general: 0,
  mature:  2,
  adult:   1,
}.freeze

Instance Method Summary collapse

Constructor Details

#initialize(a:, b:) ⇒ Client

Returns a new instance of Client.

Parameters:

  • a (String) —

    value of the ‘a` cookie

  • b (String) —

    value of the ‘b` cookie

Raises:



14
15
16
17
18
19
 
# File 'lib/furaffinity/client.rb', line 14

def initialize(a:, b:)
  raise Error.new("a needs to be a non-zero string") unless a.is_a?(String) || a.empty?
  raise Error.new("b needs to be a non-zero string") unless b.is_a?(String) || b.empty?

  @auth_cookies = { "a" => a, "b" => b }
end

Instance Method Details

#fake_update(id:, title:, rating:, description:, keywords:, lock_comments: false, scrap: false) ⇒ Object 



190
191
192
193
194
 
# File 'lib/furaffinity/client.rb', line 190

def fake_update(id:, title:, rating:, description:, keywords:, lock_comments: false, scrap: false)
  validate_args!(rating:) => { rating: }

  "https://www.furaffinity.net/view/54328944/"
end

#fake_upload(file, title:, rating:, description:, keywords:, create_folder_name: "", lock_comments: false, scrap: false, type: :submission) ⇒ Object

Raises:

  • (ArgumentError) 


76
77
78
79
80
81
82
83
 
# File 'lib/furaffinity/client.rb', line 76

def fake_upload(file, title:, rating:, description:, keywords:, create_folder_name: "", lock_comments: false, scrap: false, type: :submission)
  validate_args!(type:, rating:) => { type:, rating: }

  raise "not a file" unless file.is_a?(File)
  params = { MAX_FILE_SIZE: "10485760" }
  raise ArgumentError.new("file size of #{file.size} is greater than FA limit of #{params[:MAX_FILE_SIZE]}") if file.size > params[:MAX_FILE_SIZE].to_i
  "https://www.furaffinity.net/view/54328944/?upload-successful"
end

#get(path, client: nil) ⇒ Object 



30
31
32
33
34
35
36
 
# File 'lib/furaffinity/client.rb', line 30

def get(path, client: nil)
  client ||= http_client
  url = File.join(BASE_URL, path)
  logger.measure_trace("GET #{url}") do
    client.get(url)
  end
end

#http_client ⇒ Object 



21
22
23
24
25
26
27
28
 
# File 'lib/furaffinity/client.rb', line 21

def http_client
  HTTPX
    .plugin(:cookies)
    .plugin(:stream)
    # .plugin(:follow_redirects)
    .with(headers: { "user-agent" => "furaffinity/#{Furaffinity::VERSION} (Ruby)" })
    .with_cookies(@auth_cookies)
end

#notifications ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/furaffinity/client.rb', line 56

def notifications
  get("/")
    .then(&method(:parse_response))
    .css("a.notification-container")
    .map { _1.attr(:title) }
    .uniq
    .each_with_object({}) do |item, h|
      count, type, *_rest = item.split(" ")
      count = count.tr(",", "").strip.to_i
      h[NOTIFICATIONS_MAP.fetch(type.downcase.strip)] = count
    end
end

#post(path, form: {}, client: nil) ⇒ Object 



38
39
40
41
42
43
44
 
# File 'lib/furaffinity/client.rb', line 38

def post(path, form: {}, client: nil)
  client ||= http_client
  url = File.join(BASE_URL, path)
  logger.measure_trace("POST #{url}", { form: }) do
    client.post(url, form:)
  end
end

#submission_info(id) ⇒ Object

Returns submission information from your own gallery.



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/furaffinity/client.rb', line 163

def submission_info(id)
  client = http_client

  logger.trace { "Retrieving submission information for #{id}" }
  response = get("/controls/submissions/changeinfo/#{id}/", client:).then(&method(:parse_response))

  {}.tap do |h|
    h[:title] = response.css("form[name=MsgForm] input[name=title]").first.attr(:value)

    %i[message keywords].each do |field|
      h[field] = response.css("form[name=MsgForm] textarea[name=#{field}]").first.text
    end

    h[:rating] = RATING_MAP.invert.fetch(response.css("form[name=MsgForm] input[name=rating][checked]").first.attr(:value).to_i)

    %i[lock_comments scrap].each do |field|
      h[field] = !!response.css("form[name=MsgForm] input[name=#{field}][checked]").first&.attr(:value)
    end

    %i[cat atype species gender].each do |field|
      h[field] = response.css("form[name=MsgForm] select[name=#{field}] option[selected]").first.attr(:value)
    end

    h[:folder_ids] = response.css("form[name=MsgForm] input[name=\"folder_ids[]\"][checked]").map { _1.attr(:value) }
  end
end

#update(id:, title:, rating:, description:, keywords:, lock_comments: false, scrap: false) ⇒ Object

NOTE: only tested with ‘type=submission`



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/furaffinity/client.rb', line 197

def update(id:, title:, rating:, description:, keywords:, lock_comments: false, scrap: false)
  validate_args!(rating:) => { rating: }

  client = http_client

  # step 1: get the required keys
  logger.trace { "Extracting keys from submission #{id}" }
  response = get("/controls/submissions/changeinfo/#{id}/", client:).then(&method(:parse_response))
  already_set_params = {
    key:        response.css("form[name=MsgForm] input[name=key]").first.attr(:value),
    folder_ids: response.css("form[name=MsgForm] input[name=\"folder_ids[]\"][checked]").map { _1.attr(:value) },
  }.tap do |h|
    %i[cat atype species gender].each do |field|
      h[field] = response.css("form[name=MsgForm] select[name=#{field}] option[selected]").first.attr(:value)
    end
  end

  params = {
    update: "yes",

    rating:   RATING_MAP.fetch(rating),
    title:    title,
    message:  description,
    keywords: keywords,

    **already_set_params,

    # update button ;-)
    submit: "Update",
  }
  params[:lock_comments] = "1" if lock_comments
  params[:scrap] = "1" if scrap

  logger.debug { "Updating submission #{id}..." }
  update_response = post("/controls/submissions/changeinfo/#{id}/", form: params, client:)
  if update_response.status == 302
    redirect_location = update_response.headers[:location]
    url = File.join(BASE_URL, redirect_location)
    logger.info "Updated! #{url}"
    return url
  else
    fa_error = parse_response(update_response).css(".redirect-message").text
    raise Error.new("FA returned: #{fa_error}")
  end
end

#upload(file, title:, rating:, description:, keywords:, create_folder_name: "", lock_comments: false, scrap: false, type: :submission) ⇒ Object

Parameters:

  • file (File)

Raises:

  • (ArgumentError) 


86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/furaffinity/client.rb', line 86

def upload(file, title:, rating:, description:, keywords:, create_folder_name: "", lock_comments: false, scrap: false, type: :submission)
  validate_args!(type:, rating:) => { type:, rating: }

  client = http_client

  # step 1: get the required keys
  logger.trace "Extracting keys from upload form"
  response = get("/submit/", client:).then(&method(:parse_response))
  params = {
    submission_type: type,
    submission:      file,
    thumbnail:       {
      content_type: "application/octet-stream",
      filename: "",
      body: ""
    },
  }
  params.merge!(
    %w[MAX_FILE_SIZE key]
      .map { [_1.to_sym, response.css("form#myform input[name=#{_1}]").first.attr(:value)] }
      .to_h
  )
  raise ArgumentError.new("file size of #{file.size} is greater than FA limit of #{params[:MAX_FILE_SIZE]}") if file.size > params[:MAX_FILE_SIZE].to_i

  # step 2: upload the submission file
  logger.debug "Uploading submission..."
  upload_response = post("/submit/upload/", form: params, client:)
  # for some reason HTTPX performs a GET redirect with the params so we
  # can't use its plugin here
  # --> follow the redirect ourselves
  raise Error.new("expected a 302 response, got #{upload_response.status}") unless upload_response.status == 302

  redirect_location = upload_response.headers[:location]
  unless redirect_location == "/submit/finalize/"
    logger.warn "unexpected redirect target #{redirect_location.inspect}, expected \"/submit/finalize/\".  continuing regardless ..."
  end
  response = get(redirect_location, client:).then(&method(:parse_response))

  params = {
    key: response.css("form#myform input[name=key]").first.attr(:value),

    # category, "1" is "Visual Art -> All"
    cat: "1",
    # theme, "1" is "General Things -> All"
    atype: "1",
    # species, "1" is "Unspecified / Any"
    species: "1",
    # gender, "0" is "Any"
    gender: "0",

    rating:   RATING_MAP.fetch(rating),
    title:    title,
    message:  description,
    keywords: keywords,

    create_folder_name:,

    # finalize button :)
    finalize: "Finalize ",
  }
  params[:lock_comments] = "1" if lock_comments
  params[:scrap] = "1" if scrap

  logger.debug "Finalising submission..."
  finalize_response = post("/submit/finalize/", form: params, client:)
  if finalize_response.status == 302
    redirect_location = finalize_response.headers[:location]
    url = File.join(BASE_URL, redirect_location)
    logger.info "Uploaded! #{url}"
    return url
  else
    fa_error = parse_response(finalize_response).css(".redirect-message").text
    raise Error.new("FA returned: #{fa_error}")
  end
end