socialfred 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e085d474bfac2bac95646e7507665360669aee8e48dd282ee128cb3421f813ef
-  data.tar.gz: 21e8334d24072e40e49dc8e01d2d5bf7dc7ad03ea1df72a31404199a938f39a7
+  metadata.gz: bf0f7c212bcfde1137b710b1555eae73ac0fd25a6551d98401820693456576d0
+  data.tar.gz: eae0c693bcbc04d4ba0d92914c5bfb8662194932435aea0b64a6118a42660a51
 SHA512:
-  metadata.gz: cb9322c4e1589f15a3c2fc58d994b7b84c483fb81bf9de859f02bf2dc8fc5bbbb6313b33bbe540de6e00942c54bbaf2505f5533bdbd6ab73cafcf370dc0a35b4
-  data.tar.gz: 25d458e2733bc0e00206f809c1de24904f3e4cf9bfbbf575be43fcdd36f2138640e5303e9fef51286ffbc68bb8320da52238ecbb2468a75f448ed662b372df25
+  metadata.gz: e15d2266d35b8eff226eecfb951ec306a21ba7715abeab6838fa46778eaa5d59f1c65b0456fb7ceb3f003f22034b365c2d7c4d678a3a4d8f76c9c62e87296ba2
+  data.tar.gz: 4060f94ec07eb8fa953442dc76e12157afa1977c8d87ac76c0a58f5818c3e591ee343a6ca8a6c4421a591b064583f5413ee8afd7fb8ccf543c14ebeda9d252f0

data/.codeclimate.yml

@@ -0,0 +1,4 @@
+plugins:
+  rubocop:
+    enabled: true
+    channel: rubocop-0-74

data/.rubocop.yml

@@ -0,0 +1,44 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+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

@@ -1,4 +1,6 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in socialfred.gemspec
 gemspec

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    socialfred (1.0.0)
+      faraday (>= 0.9.0)
+      json (~> 2.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    diff-lcs (1.3)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    json (2.3.1)
+    multipart-post (2.1.1)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rainbow (3.0.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)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.86.0)
+      parallel (~> 1.10)
+      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, < 2.0)
+    rubocop-ast (0.1.0)
+      parser (>= 2.7.0.1)
+    rubocop-performance (1.6.1)
+      rubocop (>= 0.71.0)
+    rubocop-rspec (1.40.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+    vcr (5.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.86.0)
+  rubocop-performance (~> 1.6.1)
+  rubocop-rspec (~> 1.40.0)
+  socialfred!
+  vcr (~> 5.0)
+
+BUNDLED WITH
+   2.1.2

data/README.md

@@ -1,4 +1,4 @@
-# Socialfred
+# Socialfred [![Build Status](https://travis-ci.org/SocialFred/socialfred.svg?branch=master)](https://travis-ci.org/SocialFred/socialfred) [![Maintainability](https://api.codeclimate.com/v1/badges/2cd817600f03aeee7c79/maintainability)](https://codeclimate.com/github/SocialFred/socialfred/maintainability)
 
 Social Fred API Client
 
@@ -20,7 +20,169 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions
+### API Client
+
+```ruby
+api = Socialfred::Api.new(api_key)
+```
+
+### Social Posts
+
+#### Create a social post
+
+```ruby
+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],
+  options: {
+    telegram: {
+      alternative_text: "Telegram Alternative Text",
+      reply_markup: {
+        inline_keyboard: [
+          [{text: 'Button', url: 'button_url'}]
+        ]
+      }
+    }
+  }
+)
+```
+
+Response:
+
+```ruby
+{
+  'data' => {
+    'id' => '99',
+    'type' => 'publication',
+    'attributes' => {
+      'text' => 'example text',
+      'created_at' => '2019-10-30T23:54:12.147+01:00',
+      'updated_at' => '2019-10-30T23:54:12.192+01:00',
+      'status' => 'new',
+      'published_at' => '2045-06-01T12:05:00.000+01:00'
+    }
+  }
+}
+```
+
+#### Update a social post
+
+```ruby
+api.publications.update(99, text: 'another text')
+```
+
+Response:
+
+```ruby
+{
+  'data' => {
+    'id' => '99',
+    'type' => 'publication',
+    'attributes' => {
+      'text' => 'another text',
+      'created_at' => '2019-10-30T23:54:12.147+01:00',
+      'updated_at' => '2019-10-31T00:01:58.128+01:00',
+      'status' => 'new',
+      'published_at' => '2045-06-01T12:05:00.000+01:00'
+    }
+  }
+}
+```
+
+#### Destroy a social post
+
+```ruby
+api.publications.destroy(99)
+```
+
+Response:
+
+```ruby
+{
+  'data' => {
+    'id' => '99',
+    'type' => 'publication',
+    'attributes' => {
+      'text' => 'another text',
+      'created_at' => '2019-10-30T23:54:12.147+01:00',
+      'updated_at' => '2019-10-31T00:03:30.973+01:00',
+      'status' => 'to_be_deleted',
+      'published_at' => '2045-06-01T12:05:00.000+01:00'
+    }
+  }
+}
+```
+
+#### List all social posts
+
+```ruby
+api.publications.all(page: 1, per_page: 10)
+```
+
+Response:
+
+```ruby
+{
+  'data' => [
+    {
+      'id' => '98',
+      'type' => 'publication',
+      'attributes' => {
+        'text' => 'test1',
+        'created_at' => '2019-10-30T20:54:14.960+01:00',
+        'updated_at' => '2019-10-30T20:54:15.011+01:00',
+        'status' => 'new',
+        'published_at' => '2019-10-30T20:59:14.000+01:00'
+      }
+    },
+    # ...
+    {
+      'id' => '95',
+      'type' => 'publication',
+      'attributes' => {
+        'text' => 'test2',
+        'created_at' => '2019-10-29T22:46:35.857+01:00',
+        'updated_at' => '2019-10-29T23:46:41.645+01:00',
+        'status' => 'published',
+        'published_at' => '2019-10-29T23:46:35.000+01:00'
+      }
+    }
+  ],
+  'links' => {
+    '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 }
+}
+```
+
+#### Find one social post
+
+```ruby
+api.publications.find(95)
+```
+
+Response:
+
+```ruby
+{
+  'data' => {
+    'id' => '95',
+    'type' => 'publication',
+    'attributes' => {
+      'text' => 'test2',
+      'created_at' => '2019-10-29T22:46:35.857+01:00',
+      'updated_at' => '2019-10-29T23:46:41.645+01:00',
+      'status' => 'published',
+      'published_at' => '2019-10-29T23:46:35.000+01:00'
+    }
+  }
+}
+```
 
 ## Development
 

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "socialfred"
+require 'bundler/setup'
+require 'socialfred'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "socialfred"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/socialfred.rb

@@ -1,4 +1,10 @@
-require "socialfred/version"
+# frozen_string_literal: true
+
+require 'socialfred/version'
+
+require 'socialfred/api'
+
+require 'json'
 
 module Socialfred
   class Error < StandardError; end

data/lib/socialfred/api.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'socialfred/publications'
+
+module Socialfred
+  class Api
+    attr_reader :api_key, :api_url
+
+    API_URL = 'https://api.socialfred.com/'
+
+    def initialize(api_key, api_url: API_URL)
+      @api_key = api_key
+      @api_url = api_url
+    end
+
+    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 unless response.status == 200
+
+      JSON.parse(response.body)
+    end
+
+    def find(publication_id)
+      response = requester.get(ENDPOINT + "/#{publication_id}")
+
+      raise Socialfred::Error 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 unless response.status == 200
+
+      JSON.parse(response.body)
+    end
+
+    def destroy(publication_id)
+      response = requester.delete(ENDPOINT + "/#{publication_id}")
+
+      raise Socialfred::Error 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,3 +1,5 @@
+# frozen_string_literal: true
+
 module Socialfred
-  VERSION = "0.1.0"
+  VERSION = '1.0.0'
 end

data/socialfred.gemspec

@@ -1,32 +1,41 @@
-lib = File.expand_path("lib", __dir__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "socialfred/version"
+require 'socialfred/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "socialfred"
+  spec.name          = 'socialfred'
   spec.version       = Socialfred::VERSION
-  spec.authors       = ["Alexey Krasnoperov"]
-  spec.email         = ["info@socialfred.com"]
+  spec.authors       = ['Alexey Krasnoperov']
+  spec.email         = ['info@socialfred.com']
 
-  spec.summary       = %q{Social Fred API Client}
-  spec.description   = %q{Social Fred API Client: schedule social posts to multiple social networks}
-  spec.homepage      = "https://github.com/SocialFred/socialfred"
-  spec.license       = "MIT"
+  spec.summary       = 'Social Fred API Client'
+  spec.description   = 'Social Fred API Client: schedule social posts to multiple social networks'
+  spec.homepage      = 'https://github.com/socialfred/socialfred'
+  spec.license       = 'MIT'
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/SocialFred/socialfred"
-  spec.metadata["changelog_uri"] = "https://github.com/SocialFred/socialfred"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/socialfred/socialfred'
+  spec.metadata['changelog_uri'] = 'https://github.com/socialfred/socialfred'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'faraday', '>= 0.9.0'
+  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 "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  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,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: socialfred
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Alexey Krasnoperov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-27 00:00:00.000000000 Z
+date: 2020-06-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -30,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
@@ -52,6 +80,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.86.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.86.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.40.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.40.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: 'Social Fred API Client: schedule social posts to multiple social networks'
 email:
 - info@socialfred.com
@@ -59,25 +143,31 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/socialfred.rb
+- lib/socialfred/api.rb
+- lib/socialfred/publications.rb
+- lib/socialfred/requester.rb
 - lib/socialfred/version.rb
 - socialfred.gemspec
-homepage: https://github.com/SocialFred/socialfred
+homepage: https://github.com/socialfred/socialfred
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/SocialFred/socialfred
-  source_code_uri: https://github.com/SocialFred/socialfred
-  changelog_uri: https://github.com/SocialFred/socialfred
+  homepage_uri: https://github.com/socialfred/socialfred
+  source_code_uri: https://github.com/socialfred/socialfred
+  changelog_uri: https://github.com/socialfred/socialfred
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -93,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