socialfred 0.2.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7508235c71840e1bbf248ff2606e33501b550b2d2e0a5ab0488b6c8aeee3767
-  data.tar.gz: 8abcd2bc7efa8aeb5e3b98ed158a6add5c85e5f2a7c8ce39bf0c235f86f8deeb
+  metadata.gz: 7f11030d6f2232279f9c201c4b8fc2296e5e93a56f5559ec087e11cfadeff614
+  data.tar.gz: e626c0dedae80f84e81b3c0fdb6695374caf2b112d7e1c7bb82acaa5c43e65ba
 SHA512:
-  metadata.gz: 28fc572e05b9ee22247c748ea6820d07fea8cafe4544d93266b27a40f33d5896245c365a3fec28b546895c945d5a2219758db571eb7918b172c071e5c45a9bf7
-  data.tar.gz: 9c42a0003e1977414070d76ef623bd718f7fc445449ace40f8e2dd8e45f709ef7c29229ede45e1a1a37e4883964d2edbcc8ee1090e0f28138b0bfad48cc18cf5
+  metadata.gz: ddd5aa659171f8698aae7dd5f99f606b94eaac8390733d384ea869dc7f9c721f13a87b9ac30969f9b71b5276262bedad22b4e1c2f5d2293a6921f1b5dcf94087
+  data.tar.gz: 66fa6643ddab3068a02a485014c5abfa6abf51e41057110fe8257a603e3c8a080225d78dd90155e962962f665b1e11f3c643c50064094ea1d0e847205baa8743

data/.rubocop.yml

@@ -12,3 +12,33 @@ Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
     - '**/*.gemspec'
+
+### DEFAULT RULES
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true

data/Gemfile.lock

@@ -1,25 +1,26 @@
 PATH
   remote: .
   specs:
-    socialfred (0.2.0)
+    socialfred (1.0.1)
       faraday (>= 0.9.0)
       json (~> 2.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
+    ast (2.4.1)
     diff-lcs (1.3)
-    faraday (0.17.0)
+    faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
-    jaro_winkler (1.5.4)
-    json (2.2.0)
+    json (2.3.1)
     multipart-post (2.1.1)
-    parallel (1.18.0)
-    parser (2.6.5.0)
-      ast (~> 2.4.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
     rainbow (3.0.0)
-    rake (10.5.0)
+    rake (13.0.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -33,19 +34,23 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.0)
-    rubocop (0.74.0)
-      jaro_winkler (~> 1.5.1)
+    rubocop (0.86.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3, < 1.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.0)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.1.0)
+      parser (>= 2.7.0.1)
+    rubocop-performance (1.6.1)
       rubocop (>= 0.71.0)
-    rubocop-rspec (1.36.0)
+    rubocop-rspec (1.40.0)
       rubocop (>= 0.68.1)
     ruby-progressbar (1.10.1)
-    unicode-display_width (1.6.0)
+    unicode-display_width (1.7.0)
     vcr (5.0.0)
 
 PLATFORMS
@@ -53,13 +58,13 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.0)
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
-  rubocop (= 0.74)
-  rubocop-performance (~> 1.5)
-  rubocop-rspec (~> 1.36)
+  rubocop (~> 0.86.0)
+  rubocop-performance (~> 1.6.1)
+  rubocop-rspec (~> 1.40.0)
   socialfred!
   vcr (~> 5.0)
 
 BUNDLED WITH
-   2.0.2
+   2.1.2

data/README.md

@@ -31,7 +31,9 @@ api = Socialfred::Api.new(api_key)
 #### Create a social post
 
 ```ruby
-api.social_posts.create(
+image1 = {data: Base64.encode64(image.download), filename: 'image.jpeg', content_type: 'image/jpeg'}
+# ...
+api.publications.create(
   publish_at: Time.now,
   text: "example text",
   images: [image1, image2],
@@ -54,7 +56,7 @@ Response:
 {
   'data' => {
     'id' => '99',
-    'type' => 'social_post',
+    'type' => 'publication',
     'attributes' => {
       'text' => 'example text',
       'created_at' => '2019-10-30T23:54:12.147+01:00',
@@ -69,7 +71,7 @@ Response:
 #### Update a social post
 
 ```ruby
-api.social_posts.update(99, text: 'another text')
+api.publications.update(99, text: 'another text')
 ```
 
 Response:
@@ -78,7 +80,7 @@ Response:
 {
   'data' => {
     'id' => '99',
-    'type' => 'social_post',
+    'type' => 'publication',
     'attributes' => {
       'text' => 'another text',
       'created_at' => '2019-10-30T23:54:12.147+01:00',
@@ -93,7 +95,7 @@ Response:
 #### Destroy a social post
 
 ```ruby
-api.social_posts.destroy(99)
+api.publications.destroy(99)
 ```
 
 Response:
@@ -102,7 +104,7 @@ Response:
 {
   'data' => {
     'id' => '99',
-    'type' => 'social_post',
+    'type' => 'publication',
     'attributes' => {
       'text' => 'another text',
       'created_at' => '2019-10-30T23:54:12.147+01:00',
@@ -117,7 +119,7 @@ Response:
 #### List all social posts
 
 ```ruby
-api.social_posts.all(page: 1, per_page: 10)
+api.publications.all(page: 1, per_page: 10)
 ```
 
 Response:
@@ -127,7 +129,7 @@ Response:
   'data' => [
     {
       'id' => '98',
-      'type' => 'social_post',
+      'type' => 'publication',
       'attributes' => {
         'text' => 'test1',
         'created_at' => '2019-10-30T20:54:14.960+01:00',
@@ -139,7 +141,7 @@ Response:
     # ...
     {
       'id' => '95',
-      'type' => 'social_post',
+      'type' => 'publication',
       'attributes' => {
         'text' => 'test2',
         'created_at' => '2019-10-29T22:46:35.857+01:00',
@@ -150,9 +152,9 @@ Response:
     }
   ],
   'links' => {
-    'first' => 'https://socialfred.com/api/social_posts?page=1&per_page=10',
-    'last' => 'https://socialfred.com/api/social_posts?page=26&per_page=10',
-    'next' => 'https://socialfred.com/api/social_posts?page=2&per_page=10'
+    'first' => 'https://api.socialfred.com/publications?page=1&per_page=10',
+    'last' => 'https://api.socialfred.com/publications?page=26&per_page=10',
+    'next' => 'https://api.socialfred.com/publications?page=2&per_page=10'
   },
   'meta' => { 'total' => 51 }
 }
@@ -161,7 +163,7 @@ Response:
 #### Find one social post
 
 ```ruby
-api.social_posts.find(95)
+api.publications.find(95)
 ```
 
 Response:
@@ -170,7 +172,7 @@ Response:
 {
   'data' => {
     'id' => '95',
-    'type' => 'social_post',
+    'type' => 'publication',
     'attributes' => {
       'text' => 'test2',
       'created_at' => '2019-10-29T22:46:35.857+01:00',

data/lib/socialfred/api.rb

@@ -1,21 +1,20 @@
 # frozen_string_literal: true
 
-require 'faraday'
-require 'socialfred/social_posts'
+require 'socialfred/publications'
 
 module Socialfred
   class Api
     attr_reader :api_key, :api_url
 
-    API_URL = 'https://socialfred.com/api/'
+    API_URL = 'https://api.socialfred.com/'
 
     def initialize(api_key, api_url: API_URL)
       @api_key = api_key
       @api_url = api_url
     end
 
-    def social_posts
-      @social_posts ||= SocialPosts.new(api_key, api_url: api_url)
+    def publications
+      @publications ||= Publications.new(api_key, api_url: api_url)
     end
   end
 end

data/lib/socialfred/publications.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'socialfred/requester'
+require 'time'
+
+module Socialfred
+  class Publications
+    attr_reader :api_key, :api_url
+
+    ENDPOINT = 'publications'
+
+    def initialize(api_key, api_url:)
+      @api_key = api_key
+      @api_url = api_url
+    end
+
+    def all(page: 1, per_page: 10)
+      response = requester.get(ENDPOINT, page: page, per_page: per_page)
+
+      raise Socialfred::Error, response.body unless response.status == 200
+
+      JSON.parse(response.body)
+    end
+
+    def find(publication_id)
+      response = requester.get(ENDPOINT + "/#{publication_id}")
+
+      raise Socialfred::Error, response.body unless response.status == 200
+
+      JSON.parse(response.body)
+    end
+
+    def create(publish_at: nil, text:, images: nil, options: nil)
+      check_images(images) if images
+
+      publish_at = Time.parse(publish_at.to_s).iso8601 if publish_at
+      parameters = { publication: { published_at: publish_at, text: text, images: images, options: options }.compact }
+      response = requester.post(ENDPOINT, parameters)
+
+      raise Socialfred::Error, response.body unless response.status == 200
+
+      JSON.parse(response.body)
+    end
+
+    def update(publication_id, publish_at: nil, text: nil, images: nil, options: nil)
+      check_images(images) if images
+
+      publish_at = Time.parse(publish_at.to_s).iso8601 if publish_at
+      parameters = { publication: { published_at: publish_at, text: text, images: images, options: options }.compact }
+      response = requester.put(ENDPOINT + "/#{publication_id}", parameters)
+
+      raise Socialfred::Error, response.body unless response.status == 200
+
+      JSON.parse(response.body)
+    end
+
+    def destroy(publication_id)
+      response = requester.delete(ENDPOINT + "/#{publication_id}")
+
+      raise Socialfred::Error, response.body unless response.status == 200
+
+      JSON.parse(response.body)
+    end
+
+    private
+
+    def check_images(images)
+      raise(Socialfred::Error, 'images must be array') unless images.is_a?(Array)
+      return if images.all? { |image| image.key?(:data) && image.key?(:filename) && image.key?(:content_type) }
+
+      raise(
+        Socialfred::Error,
+        'images must contain the following attributes: data (base64 encoded image), filename and content_type'
+      )
+    end
+
+    def requester
+      @requester ||= Requester.new(api_key, api_url)
+    end
+  end
+end

data/lib/socialfred/requester.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module Socialfred
+  class Requester
+    attr_reader :api_key, :api_url
+
+    CONTENT_TYPE = 'application/json'
+
+    def initialize(api_key, api_url)
+      @api_key = api_key
+      @api_url = api_url
+    end
+
+    def get(endpoint, parameters = nil)
+      conn.get(endpoint, parameters) do |req|
+        req.headers[:content_type] = CONTENT_TYPE
+      end
+    end
+
+    def post(endpoint, parameters = nil)
+      conn.post(endpoint) do |req|
+        req.headers[:content_type] = CONTENT_TYPE
+        req.body = JSON.generate(parameters)
+      end
+    end
+
+    def put(endpoint, parameters = nil)
+      conn.put(endpoint) do |req|
+        req.headers[:content_type] = CONTENT_TYPE
+        req.body = JSON.generate(parameters)
+      end
+    end
+
+    def delete(endpoint)
+      conn.delete(endpoint) do |req|
+        req.headers[:content_type] = CONTENT_TYPE
+      end
+    end
+
+    private
+
+    def conn
+      @conn ||= Faraday.new(url: api_url) do |faraday|
+        faraday.adapter Faraday.default_adapter
+        faraday.headers['Api-Key'] = api_key
+      end
+    end
+  end
+end

data/lib/socialfred/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Socialfred
-  VERSION = '0.2.0'
+  VERSION = '1.0.1'
 end

data/socialfred.gemspec

@@ -32,10 +32,10 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'json', '~> 2.2'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '0.74'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.5'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.36'
+  spec.add_development_dependency 'rubocop', '~> 0.86.0'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.6.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.40.0'
   spec.add_development_dependency 'vcr', '~> 5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: socialfred
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Alexey Krasnoperov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-31 00:00:00.000000000 Z
+date: 2020-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -84,44 +84,44 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.74'
+        version: 0.86.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.74'
+        version: 0.86.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 1.6.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 1.6.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.36'
+        version: 1.40.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.36'
+        version: 1.40.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -157,7 +157,8 @@ files:
 - bin/setup
 - lib/socialfred.rb
 - lib/socialfred/api.rb
-- lib/socialfred/social_posts.rb
+- lib/socialfred/publications.rb
+- lib/socialfred/requester.rb
 - lib/socialfred/version.rb
 - socialfred.gemspec
 homepage: https://github.com/socialfred/socialfred
@@ -182,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Social Fred API Client

data/lib/socialfred/social_posts.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-require 'time'
-
-module Socialfred
-  class SocialPosts
-    attr_reader :api_key, :api_url
-
-    ENDPOINT = 'social_posts'
-
-    def initialize(api_key, api_url:)
-      @api_key = api_key
-      @api_url = api_url
-    end
-
-    def all(page: 1, per_page: 10)
-      response = conn.get(ENDPOINT, page: page, per_page: per_page)
-
-      raise Socialfred::Error unless response.status == 200
-
-      JSON.parse(response.body)
-    end
-
-    def find(social_post_id)
-      response = conn.get(ENDPOINT + "/#{social_post_id}")
-
-      raise Socialfred::Error unless response.status == 200
-
-      JSON.parse(response.body)
-    end
-
-    def create(publish_at: nil, text:, images: nil, options: nil)
-      publish_at = Time.parse(publish_at.to_s).iso8601 if publish_at
-      parameters = { social_post: { published_at: publish_at, text: text, images: images, options: options }.compact }
-      response = conn.post(ENDPOINT, parameters)
-
-      raise Socialfred::Error unless response.status == 200
-
-      JSON.parse(response.body)
-    end
-
-    def update(social_post_id, publish_at: nil, text:, images: nil, options: nil)
-      publish_at = Time.parse(publish_at.to_s).iso8601 if publish_at
-      parameters = { social_post: { published_at: publish_at, text: text, images: images, options: options }.compact }
-      response = conn.put(ENDPOINT + "/#{social_post_id}", parameters)
-
-      raise Socialfred::Error unless response.status == 200
-
-      JSON.parse(response.body)
-    end
-
-    def destroy(social_post_id)
-      response = conn.delete(ENDPOINT + "/#{social_post_id}")
-
-      raise Socialfred::Error unless response.status == 200
-
-      JSON.parse(response.body)
-    end
-
-    private
-
-    def conn
-      @conn ||= Faraday.new(url: api_url) do |faraday|
-        faraday.request :multipart
-        faraday.request :url_encoded
-        faraday.adapter Faraday.default_adapter
-        faraday.headers['Api-Key'] = api_key
-      end
-    end
-  end
-end